getter.gno

gnoswap/contract/r/gnoswap/launchpad/v1/getter.gno at d9d34bd345a36c3eedaccf491c6615b0ac4168cd · gnoswap-labs/gnoswapGitHub

gnoswap/contract/r/gnoswap/launchpad/getter.gno at d9d34bd345a36c3eedaccf491c6615b0ac4168cd · gnoswap-labs/gnoswapGitHub

GetCurrentDepositId

func GetCurrentDepositId() int64

GetCurrentDepositId returns the current deposit counter value.

Return Values

Name	Type	Description
depositId	int64	current deposit counter value; it is not incremented by this read.

source

GetDepositAmount

func GetDepositAmount(
	depositId string
) (int64, error)

GetDepositAmount returns the deposit amount of a deposit by its ID.

Parameters

Name	Type	Description
depositId	string	unique identifier of the deposit to inspect.

Return Values

Name	Type	Description
amount	int64	GNS principal deposited, in base units.
err	error	non-nil when depositId does not identify a stored deposit.

source

GetDepositCount

func GetDepositCount() int

GetDepositCount returns the total number of deposits.

Return Values

Name	Type	Description
count	int	number of deposit records currently stored.

source

GetDepositCreatedAt

func GetDepositCreatedAt(
	depositId string
) (int64, error)

GetDepositCreatedAt returns the created time of a deposit by its ID.

Parameters

Name	Type	Description
depositId	string	unique identifier of the deposit to inspect.

Return Values

Name	Type	Description
createdAt	int64	deposit creation Unix timestamp in seconds.
err	error	non-nil when depositId does not identify a stored deposit.

source

GetDepositCreatedHeight

func GetDepositCreatedHeight(
	depositId string
) (int64, error)

GetDepositCreatedHeight returns the created height of a deposit by its ID.

Parameters

Name	Type	Description
depositId	string	unique identifier of the deposit to inspect.

Return Values

Name	Type	Description
height	int64	creation block height of the deposit.
err	error	non-nil when depositId does not identify a stored deposit.

source

GetDepositEndTime

func GetDepositEndTime(
	depositId string
) (int64, error)

GetDepositEndTime returns the end time of a deposit by its ID.

Parameters

Name	Type	Description
depositId	string	unique identifier of the deposit to inspect.

Return Values

Name	Type	Description
endTime	int64	deposit lock/end Unix timestamp in seconds.
err	error	non-nil when depositId does not identify a stored deposit.

source

GetDepositProjectID

func GetDepositProjectID(
	depositId string
) (string, error)

GetDepositProjectID returns the project ID of a deposit by its ID.

Parameters

Name	Type	Description
depositId	string	unique identifier of the deposit to inspect.

Return Values

Name	Type	Description
projectId	string	project identifier associated with the deposit.
err	error	non-nil when depositId does not identify a stored deposit.

source

GetDepositProjectTierID

func GetDepositProjectTierID(
	depositId string
) (string, error)

GetDepositProjectTierID returns the project tier ID of a deposit by its ID.

Parameters

Name	Type	Description
depositId	string	unique identifier of the deposit to inspect.

Return Values

Name	Type	Description
projectTierId	string	composite project-tier identifier derived from the deposit's project and tier.
err	error	non-nil when depositId does not identify a stored deposit.

source

GetDepositTier

func GetDepositTier(
	depositId string
) (int64, error)

GetDepositTier returns the tier of a deposit by its ID.

Parameters

Name	Type	Description
depositId	string	unique identifier of the deposit to inspect.

Return Values

Name	Type	Description
tier	int64	tier duration key selected by the deposit.
err	error	non-nil when depositId does not identify a stored deposit.

source

GetDepositWithdrawnHeight

func GetDepositWithdrawnHeight(
	depositId string
) (int64, error)

GetDepositWithdrawnHeight returns the withdrawn height of a deposit by its ID.

Parameters

Name	Type	Description
depositId	string	unique identifier of the deposit to inspect.

Return Values

Name	Type	Description
height	int64	withdrawal block height; zero when the deposit has not been withdrawn.
err	error	non-nil when depositId does not identify a stored deposit.

source

GetDepositWithdrawnTime

func GetDepositWithdrawnTime(
	depositId string
) (int64, error)

GetDepositWithdrawnTime returns the withdrawn time of a deposit by its ID.

Parameters

Name	Type	Description
depositId	string	unique identifier of the deposit to inspect.

Return Values

Name	Type	Description
withdrawnAt	int64	withdrawal Unix timestamp in seconds; zero when the deposit has not been withdrawn.
err	error	non-nil when depositId does not identify a stored deposit.

source

GetProjectActiveStatus

func GetProjectActiveStatus(
	projectId string
) (bool, error)

GetProjectActiveStatus returns whether a project is currently active.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project to inspect.

Return Values

Name	Type	Description
active	bool	true when the project is active at the current Unix time; false when it is inactive.
err	error	non-nil when projectId does not identify a stored project.

source

GetProjectCreatedAt

func GetProjectCreatedAt(
	projectId string
) (int64, error)

GetProjectCreatedAt returns the created time of a project by its ID.

Parameters

Name	Type	Description
projectId	string	unique identifier of the launchpad project to inspect.

Return Values

Name	Type	Description
createdAt	int64	Unix timestamp in seconds at which the project was created.
err	error	non-nil when projectId does not identify a stored project.

source

GetProjectCreatedHeight

func GetProjectCreatedHeight(
	projectId string
) (int64, error)

GetProjectCreatedHeight returns the created height of a project by its ID.

Parameters

Name	Type	Description
projectId	string	unique identifier of the launchpad project to inspect.

Return Values

Name	Type	Description
height	int64	block height at which the project was created.
err	error	non-nil when projectId does not identify a stored project.

source

GetProjectDepositAmount

func GetProjectDepositAmount(
	projectId string
) (int64, error)

GetProjectDepositAmount returns the deposit amount of a project by its ID.

Parameters

Name	Type	Description
projectId	string	unique identifier of the launchpad project to inspect.

Return Values

Name	Type	Description
amount	int64	project-token amount initially allocated to the project, in token base units.
err	error	non-nil when projectId does not identify a stored project.

source

GetProjectName

func GetProjectName(
	projectId string
) (string, error)

GetProjectName returns the name of a project by its ID.

Parameters

Name	Type	Description
projectId	string	unique identifier of the launchpad project to inspect.

Return Values

Name	Type	Description
name	string	stored project name.
err	error	non-nil when projectId does not identify a stored project.

source

GetProjectRecipient

func GetProjectRecipient(
	projectId string
) (address, error)

GetProjectRecipient returns the recipient address of a project by its ID.

Parameters

Name	Type	Description
projectId	string	unique identifier of the launchpad project to inspect.

Return Values

Name	Type	Description
recipient	address	address configured to receive the project's launchpad proceeds.
err	error	non-nil when projectId does not identify a stored project.

source

GetProjectTierDistributeAmountPerSecondX128

func GetProjectTierDistributeAmountPerSecondX128(
	projectId string,
	tier int64
) (*u256.Uint, error)

GetProjectTierDistributeAmountPerSecondX128 returns the distribute amount per second (Q128) of a project tier.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
amountPerSecondX128	*u256.Uint	project-token distribution rate per second in Q128 fixed-point units; nil when no value is available.
err	error	non-nil when the project or tier cannot be found.

source

GetProjectTierEndTime

func GetProjectTierEndTime(
	projectId string,
	tier int64
) (int64, error)

GetProjectTierEndTime returns the end time of a project tier.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
endTime	int64	tier end timestamp in Unix seconds.
err	error	non-nil when the project or tier cannot be found.

source

GetProjectTierRewardAccumulatedDistributeAmount

func GetProjectTierRewardAccumulatedDistributeAmount(
	projectTierId string
) (int64, error)

GetProjectTierRewardAccumulatedDistributeAmount returns a legacy reward-manager field. The v1 reward paths do not maintain it, so normal reads return zero unless it was explicitly set.

Parameters

Name	Type	Description
projectTierId	string	composite project-tier identifier whose manager is requested.

Return Values

Name	Type	Description
amount	int64	legacy accumulated distribution amount in token base units; v1 accounting normally leaves it at zero unless explicitly set.
err	error	non-nil when projectTierId does not identify a stored reward manager.

source

GetProjectTierRewardAccumulatedRewardPerDepositX128

func GetProjectTierRewardAccumulatedRewardPerDepositX128(
	projectTierId string
) (*u256.Uint, error)

GetProjectTierRewardAccumulatedRewardPerDepositX128 returns the accumulated reward per deposit (Q128) of a reward manager.

Parameters

Name	Type	Description
projectTierId	string	composite project-tier identifier whose manager is requested.

Return Values

Name	Type	Description
accumulatedRewardPerDepositX128	*u256.Uint	accumulated reward index per deposited GNS unit in Q128 fixed-point units; nil when no value is available.
err	error	non-nil when projectTierId does not identify a stored reward manager.

source

GetProjectTierRewardAccumulatedTime

func GetProjectTierRewardAccumulatedTime(
	projectTierId string
) (int64, error)

GetProjectTierRewardAccumulatedTime returns the accumulated time of a reward manager.

Parameters

Name	Type	Description
projectTierId	string	composite project-tier identifier whose manager is requested.

Return Values

Name	Type	Description
time	int64	last reward-accumulation timestamp in Unix seconds, or zero before accumulation.
err	error	non-nil when projectTierId does not identify a stored reward manager.

source

GetProjectTierRewardClaimableDuration

func GetProjectTierRewardClaimableDuration(
	projectTierId string
) (int64, error)

GetProjectTierRewardClaimableDuration returns the reward claimable duration of a reward manager.

Parameters

Name	Type	Description
projectTierId	string	composite project-tier identifier whose manager is requested.

Return Values

Name	Type	Description
duration	int64	reward claimable window in seconds.
err	error	non-nil when projectTierId does not identify a stored reward manager.

source

GetProjectTierRewardDistributeAmountPerSecondX128

func GetProjectTierRewardDistributeAmountPerSecondX128(
	projectTierId string
) (*u256.Uint, error)

GetProjectTierRewardDistributeAmountPerSecondX128 returns the distribute amount per second (Q128) of a reward manager.

Parameters

Name	Type	Description
projectTierId	string	composite project-tier identifier whose manager is requested.

Return Values

Name	Type	Description
amountPerSecondX128	*u256.Uint	reward distribution rate per second in Q128 fixed-point token units; nil when no value is available.
err	error	non-nil when projectTierId does not identify a stored reward manager.

source

GetProjectTierRewardDistributeEndTime

func GetProjectTierRewardDistributeEndTime(
	projectTierId string
) (int64, error)

GetProjectTierRewardDistributeEndTime returns the distribute end time of a reward manager.

Parameters

Name	Type	Description
projectTierId	string	composite project-tier identifier whose manager is requested.

Return Values

Name	Type	Description
endTime	int64	reward distribution end timestamp in Unix seconds.
err	error	non-nil when projectTierId does not identify a stored reward manager.

source

GetProjectTierRewardDistributeStartTime

func GetProjectTierRewardDistributeStartTime(
	projectTierId string
) (int64, error)

GetProjectTierRewardDistributeStartTime returns the distribute start time of a reward manager.

Parameters

Name	Type	Description
projectTierId	string	composite project-tier identifier whose manager is requested.

Return Values

Name	Type	Description
startTime	int64	reward distribution start timestamp in Unix seconds.
err	error	non-nil when projectTierId does not identify a stored reward manager.

source

GetProjectTierRewardManagerCount

func GetProjectTierRewardManagerCount() int

GetProjectTierRewardManagerCount returns the total number of reward managers.

Return Values

Name	Type	Description
count	int	number of project-tier reward managers currently stored.

source

GetProjectTierRewardTotalClaimedAmount

func GetProjectTierRewardTotalClaimedAmount(
	projectTierId string
) (int64, error)

GetProjectTierRewardTotalClaimedAmount returns the total claimed amount of a reward manager.

Parameters

Name	Type	Description
projectTierId	string	composite project-tier identifier whose manager is requested.

Return Values

Name	Type	Description
amount	int64	total reward amount claimed from the manager, in token base units.
err	error	non-nil when projectTierId does not identify a stored reward manager.

source

GetProjectTierRewardTotalDistributeAmount

func GetProjectTierRewardTotalDistributeAmount(
	projectTierId string
) (int64, error)

GetProjectTierRewardTotalDistributeAmount returns the total distribute amount of a reward manager.

Parameters

Name	Type	Description
projectTierId	string	composite project-tier identifier whose manager is requested.

Return Values

Name	Type	Description
amount	int64	total reward allocation managed for the project tier, in token base units.
err	error	non-nil when projectTierId does not identify a stored reward manager.

source

GetProjectTierRewards

func GetProjectTierRewards(
	projectId string,
	tier int64
) *rotree.ReadOnlyTree

GetProjectTierRewards returns a read-only view of a project tier's reward states, keyed by deposit ID. Reading an entry yields a clone, so the view cannot mutate realm state. nil is returned when the project tier does not exist.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
rewards	*rotree.ReadOnlyTree	read-only tree of reward states keyed by deposit ID; nil when the tier's reward manager is unavailable.

source

GetProjectTierStartTime

func GetProjectTierStartTime(
	projectId string,
	tier int64
) (int64, error)

GetProjectTierStartTime returns the start time of a project tier.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
startTime	int64	tier start timestamp in Unix seconds.
err	error	non-nil when the project or tier cannot be found.

source

GetProjectTierTotalCollectedAmount

func GetProjectTierTotalCollectedAmount(
	projectId string,
	tier int64
) (int64, error)

GetProjectTierTotalCollectedAmount returns the total collected amount of a project tier.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
amount	int64	cumulative project-token reward collected from the tier, in token base units.
err	error	non-nil when the project or tier cannot be found.

source

GetProjectTierTotalDepositAmount

func GetProjectTierTotalDepositAmount(
	projectId string,
	tier int64
) (int64, error)

GetProjectTierTotalDepositAmount returns the total deposit amount of a project tier.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
amount	int64	cumulative GNS principal deposited into the tier, in base units.
err	error	non-nil when the project or tier cannot be found.

source

GetProjectTierTotalDepositCount

func GetProjectTierTotalDepositCount(
	projectId string,
	tier int64
) (int64, error)

GetProjectTierTotalDepositCount returns the total deposit count of a project tier.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
count	int64	cumulative number of deposits created in the tier.
err	error	non-nil when the project or tier cannot be found.

source

GetProjectTierTotalDistributeAmount

func GetProjectTierTotalDistributeAmount(
	projectId string,
	tier int64
) (int64, error)

GetProjectTierTotalDistributeAmount returns the total distribute amount of a project tier.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
amount	int64	total project-token allocation for the tier, in token base units.
err	error	non-nil when the project or tier cannot be found.

source

GetProjectTierTotalWithdrawAmount

func GetProjectTierTotalWithdrawAmount(
	projectId string,
	tier int64
) (int64, error)

GetProjectTierTotalWithdrawAmount returns the total withdraw amount of a project tier.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
amount	int64	cumulative GNS principal withdrawn from the tier, in base units.
err	error	non-nil when the project or tier cannot be found.

source

GetProjectTierTotalWithdrawCount

func GetProjectTierTotalWithdrawCount(
	projectId string,
	tier int64
) (int64, error)

GetProjectTierTotalWithdrawCount returns the total withdraw count of a project tier.

Parameters

Name	Type	Description
projectId	string	unique identifier of the project containing the tier.
tier	int64	tier duration key, such as 30, 90, or 180.

Return Values

Name	Type	Description
count	int64	cumulative number of withdrawals completed in the tier.
err	error	non-nil when the project or tier cannot be found.

source

GetProjectTiersRatios

func GetProjectTiersRatios(
	projectId string
) (map[int64]int64, error)

GetProjectTiersRatios returns the tiers ratios map of a project by its ID.

Parameters

Name	Type	Description
projectId	string	unique identifier of the launchpad project to inspect.

Return Values

Name	Type	Description
tiersRatios	map[int64]int64	cloned map from tier duration to its allocation ratio.
err	error	non-nil when projectId does not identify a stored project.

source

GetProjectTokenPath

func GetProjectTokenPath(
	projectId string
) (string, error)

GetProjectTokenPath returns the token path of a project by its ID.

Parameters

Name	Type	Description
projectId	string	unique identifier of the launchpad project to inspect.

Return Values

Name	Type	Description
tokenPath	string	reward-token contract path configured for the project.
err	error	non-nil when projectId does not identify a stored project.

source

GetProjects

func GetProjects() *rotree.ReadOnlyTree

GetProjects returns a read-only view of every project, keyed by project ID. Callers paginate it themselves through IterateByOffset. Reading an entry yields a clone, so the view cannot mutate realm state.

Return Values

Name	Type	Description
projects	*rotree.ReadOnlyTree	read-only tree keyed by project ID; reading an entry yields a clone.

source

GetTotalGNSStakedAmount

func GetTotalGNSStakedAmount() int64

GetTotalGNSStakedAmount returns the total amount of GNS currently staked across all launchpad deposits.

Return Values

Name	Type	Description
amount	int64	total GNS principal currently staked across launchpad deposits, in base units.

source