Coda by Ian Macalinao
    Preparing search index...

    Interface CpAmmPluginPdas

    interface CpAmmPluginPdas {
        claimFeeOperator: (
            seeds: ClaimFeeOperatorSeeds,
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        config: (
            seeds: ConfigSeeds,
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        customizablePool: (
            seeds: CustomizablePoolSeeds,
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        eventAuthority: (
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        pool: (
            seeds: PoolSeeds,
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        poolAuthority: (
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        position: (
            seeds: PositionSeeds,
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        positionNftAccount: (
            seeds: PositionNftAccountSeeds,
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        rewardVault: (
            seeds: RewardVaultSeeds,
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        tokenBadge: (
            seeds: TokenBadgeSeeds,
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
        tokenVault: (
            seeds: TokenVaultSeeds,
            config?: { programAddress?: Address },
        ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>;
    }
    Index

    Properties

    claimFeeOperator config customizablePool eventAuthority pool poolAuthority position positionNftAccount rewardVault tokenBadge tokenVault

    Properties

    claimFeeOperator: (
        seeds: ClaimFeeOperatorSeeds,
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            seeds: ClaimFeeOperatorSeeds,
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • A claim fee operator account that authorizes an address to claim protocol fees. Operators can collect fees on behalf of the protocol.

        Parameters

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    config: (
        seeds: ConfigSeeds,
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            seeds: ConfigSeeds,
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • Configuration account that stores global protocol settings. Each config is indexed by a unique u64 index.

        Parameters

        • seeds: ConfigSeeds
        • config: { programAddress?: Address } = {}

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    customizablePool: (
        seeds: CustomizablePoolSeeds,
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            seeds: CustomizablePoolSeeds,
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • A customizable pool account that allows for custom fee configurations. Unlike regular pools, customizable pools are not tied to a config account. Token mints must be sorted - tokenAMint should be lexicographically smaller than tokenBMint.

        Parameters

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    eventAuthority: (
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • The event authority PDA used for emitting program events via CPI.

        Parameters

        • config: { programAddress?: Address } = {}

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    pool: (
        seeds: PoolSeeds,
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            seeds: PoolSeeds,
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • A liquidity pool account for a specific token pair under a given config. Token mints must be sorted - tokenAMint should be lexicographically smaller than tokenBMint.

        Parameters

        • seeds: PoolSeeds
        • config: { programAddress?: Address } = {}

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    poolAuthority: (
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • The global pool authority PDA that has authority over all pools in the program.

        Parameters

        • config: { programAddress?: Address } = {}

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    position: (
        seeds: PositionSeeds,
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            seeds: PositionSeeds,
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • A liquidity position account that tracks a user's deposited liquidity. Each position is uniquely identified by its associated NFT mint.

        Parameters

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    positionNftAccount: (
        seeds: PositionNftAccountSeeds,
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            seeds: PositionNftAccountSeeds,
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • The token account that holds the position NFT. This is a program-owned account that stores the NFT representing a liquidity position.

        Parameters

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    rewardVault: (
        seeds: RewardVaultSeeds,
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            seeds: RewardVaultSeeds,
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • A reward vault account that holds reward tokens for distribution to liquidity providers. Each pool can have multiple reward vaults indexed by rewardIndex (0-2).

        Parameters

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    tokenBadge: (
        seeds: TokenBadgeSeeds,
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            seeds: TokenBadgeSeeds,
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • A token badge account that stores metadata about a token's permissions and status. Used to whitelist or configure specific tokens for use in pools.

        Parameters

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    tokenVault: (
        seeds: TokenVaultSeeds,
        config?: { programAddress?: Address },
    ) => Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Type Declaration

      • (
            seeds: TokenVaultSeeds,
            config?: { programAddress?: Address },
        ): Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

      • A token vault account that holds tokens for a specific pool. Each pool has separate vaults for token A and token B.

        Parameters

        Returns Promise<readonly [Address<string>, ProgramDerivedAddressBump]>

    Settings

    Member Visibility

    On This Page

    Properties