README.md

Cygnus Tool: Adding Canisters

The Cygnus Tool provides users with three different implementation types for adding canisters:

1. Cygnus Library: Import Cygnus code into your Canister using one of the following programming languages:

   • Motoko

   In addition, you can view a list of controllers and withdraw cycles from this type of canister.

2. Blackhole Canister: This option grants access to an immutable canister.

   • Cygnus Blackhole Canister

   Similar to the Cygnus Library, you can view a list of controllers for the Blackhole Canister. However, withdrawing cycles is not possible.

3. Available Cycles (Public method): This method exposes the availableCycles function in your code, commonly used in ext NFT token standards. An example implementation is provided below:

   public query func availableCycles() : async Nat {	
   	return Cycles.balance();
   };

   You can also whitelist the following PrincipalId to restrict access and only Cygnys can retrieve the cycles data.

CYGNUS_CANISTER_ID: "dowzh-nyaaa-aaaai-qnowq-cai"

For this type of canister, controllers and the ability to withdraw cycles are not visible.

There are two ways to add a canister to the Cygnus Tool:

1. Using the Front-End Tool: Utilize the front-end tool provided.

2. Using Cygnus Candid File: Add the canister using the Cygnus candid file.

   An example is provided below in Motoko:

    public shared(msg) func registerCanister() : async Text {

        let CYGNUS_CANISTER_ID = "dowzh-nyaaa-aaaai-qnowq-cai";
        type implementationType = {
                #AvailableCycles;
                #BlackholeCanister;
                #CygnusLibrary;
		#SnsCanister;
            };

        let CygnusCanitser = actor (CYGNUS_CANISTER_ID) : actor {
                            registerProjectCanister : shared (
                                {
                                    projectId : Text;
                                    canisterIdToBeRegistered : Text;
                                    canisterName : Text;
                                    implementationType : implementationType;
                                    topUpAmountInTrillon: ?Float;
                                    thresholdAmountInTrillon:?Float;
                                })-> async (Text);
        };

        await CygnusCanitser.registerProjectCanister({
            projectId = "upr_0E5CHK7ZYP4XRTK807VFSZCQTH";
            canisterIdToBeRegistered = "r75rh-rqaaa-aaaah-qctda-cai";
            canisterName = "Eleos";
            implementationType = #AvailableCycles;
            topUpAmountInTrillon = ?15.0;
            thresholdAmountInTrillon = ?5.0;
        });
    };

//if you do not pass topUpAmountInTrillon and thresholdAmountInTrillon values, we set the default values to 4.00T and 1.00T respectfully. 

Please note that in the registerProjectCanister function, you need to provide the appropriate values for projectId, canisterId, canisterName, and implementationType to register the desired canister.