Added IDO Program Milestone Project #85

0xcatrovacer · 2023-06-26T14:06:15Z

Anchor milestone project based on advanced Anchor concepts

Concepts added:

Cross Program Invocations
Access Control
Constants
Errors
Testing

@acheroncrypto

buffalojoec · 2023-06-26T15:48:35Z

Commenting so I get updatez

From RFP for Anchor Book contributions

acheroncrypto

Hey, thank you for the contribution. Please see the review comments(some are pretty repetitive) that should be addressed before this can get merged.

It would be great if the explanation side of things improved as well. When contributing to a book of something such as anchor book, it's expected for the contributors to have a higher degree of precision in their words. I'll give an example: The term "fiat" and "stablecoin" are two different phenomena and should not be used interchangebly. The word "fiat" has been used 435 times in this PR yet it doesn't look like anything in the program that checks whether that's the case and the program doesn't have to use "fiat" anyway.

programs/ido-program/Anchor.toml

programs/ido-program/migrations/deploy.ts

programs/ido-program/package.json

programs/ido-program/programs/ido-program/src/lib.rs

src/anchor_in_depth/milestone_project_ido-program.md

Co-authored-by: acheron <[email protected]>

buffalojoec · 2023-07-03T15:42:16Z

programs/ido-program/programs/ido-program/src/lib.rs

+
+    /// CHECK: This is not dangerous
+    #[account(mut)]
+    pub pool_signer: AccountInfo<'info>,


I think _authority is a better naming convention here, especially considering it's not signing anything in this instruction

I think that would be very confusing considering we also have authority account.

_ generally means not being used in Rust and it's good practice to make account names consistent in instructions.

This was meant as a suffix, ie *_authority

Just to be clear, should I be using pool_signer or pool_authority?

buffalojoec · 2023-07-03T15:44:06Z

programs/ido-program/programs/ido-program/src/lib.rs

+impl<'info> InitializePool<'info> {
+    fn accounts(ctx: &Context<InitializePool<'info>>, bump: u8) -> Result<()> {
+        let expected_signer = Pubkey::create_program_address(
+            &[ctx.accounts.pool_native.mint.as_ref(), &[bump]],
+            ctx.program_id,
+        )
+        .map_err(|_| ErrorCode::InvalidBump)?;
+        if ctx.accounts.pool_signer.key != &expected_signer {
+            return Err(ErrorCode::InvalidBump.into());
+        }
+        Ok(())
+    }
+}


The function you instead want to use is Pubkey::find_program_address() and it will take the seeds (without bump) and return the Pubkey and the bump.

You really shouldn't need to pass the bump as an instruction parameter

acheroncrypto

For the terms, we could use depositor instead of investor and deposit token instead of fiat.

acheroncrypto · 2023-07-03T16:49:56Z

programs/ido-program/programs/ido-program/src/lib.rs

+
+    /// CHECK: This is not dangerous
+    #[account(mut)]
+    pub pool_signer: AccountInfo<'info>,


I think that would be very confusing considering we also have authority account.

_ generally means not being used in Rust and it's good practice to make account names consistent in instructions.

acheroncrypto · 2023-07-03T16:50:56Z

programs/ido-program/programs/ido-program/src/lib.rs

+impl<'info> InitializePool<'info> {
+    fn accounts(ctx: &Context<InitializePool<'info>>, bump: u8) -> Result<()> {
+        let expected_signer = Pubkey::create_program_address(
+            &[ctx.accounts.pool_native.mint.as_ref(), &[bump]],
+            ctx.program_id,
+        )
+        .map_err(|_| ErrorCode::InvalidBump)?;
+        if ctx.accounts.pool_signer.key != &expected_signer {
+            return Err(ErrorCode::InvalidBump.into());
+        }
+        Ok(())
+    }
+}


Though both are valid and you are free to use Native validations, it's not "Anchor way" of doing things.

There is #[instruction(...)] macro if you want to get instruction arguments and validating seeds/bump should be done with #[account(...)] macro, especially in the Anchor Book.

programs/ido-program/programs/ido-program/src/lib.rs

acheroncrypto · 2023-07-03T16:52:07Z

src/anchor_in_depth/milestone_project_ido-program.md

+
+This program will be doing a couple of things. In an IDO, a project distributes its native tokens among willing investors. There are a few types of IDOs which are done. We will be implementing a fair launch IDO platform. In here, a project escrows the native tokens into a pool. When the IDO opens, investors come and deposit their fiat tokens into the pool. After the IDO is over, investors can claim their native tokens, the amount of which is calculated by the the pool percentage share of their deposit. The project can also finally withdraw all the deposited fiat tokens.
+
+We recommend keeping programs in a single `lib.rs` file.


Why do we recommend this?

Although maintaining a project directory structure is a good practice, implementing it in the milestone project might make the Anchor Book content massive.

0xcatrovacer · 2023-07-04T18:41:21Z

@acheroncrypto @buffalojoec
Made all the recommended changes in the program and the content. Please take a look.

Aursen

I tried to do a little review of the program without necessarily focusing on the rest, I hope it can be useful

Aursen · 2023-07-21T17:01:24Z

programs/ido-program/programs/ido-program/src/lib.rs

+    pub token_program: Program<'info, Token>,
+}
+
+#[account]


Here you can just add #[derive(InitSpace)] and remove the LEN const

Aursen · 2023-07-21T17:02:22Z

programs/ido-program/programs/ido-program/src/lib.rs

+    pub fn exchange_redeemable_for_native(ctx: Context<ExchangeRedeemableForNative>) -> Result<()> {
+        let native_amount = (ctx.accounts.depositor_redeemable.amount as u128)
+            .checked_mul(ctx.accounts.pool_native.amount as u128)
+            .unwrap()


better here to chain and unwrap at the end (the better is a result)

Aursen · 2023-07-21T17:03:52Z

programs/ido-program/programs/ido-program/src/lib.rs

+        pool.end_ido_ts = end_ido_ts;
+        pool.withdraw_deposit_token_ts = withdraw_deposit_token_ts;
+
+        pool.bump = bump;


Not a huge fan to let set the bump by an argument, it let place to bump seed non canonicalization exploit

Aursen · 2023-07-21T17:04:18Z

programs/ido-program/programs/ido-program/src/lib.rs

+        }
+        // While token::transfer will check this, we prefer a verbose error msg
+        if ctx.accounts.depositor_deposit_token.amount < amount {
+            return Err(ErrorCode::LowDepositToken.into());


maybe here use require! macro

Aursen · 2023-07-21T17:05:44Z

programs/ido-program/programs/ido-program/src/lib.rs

+    pub native_mint: Box<Account<'info, Mint>>,
+
+    #[account(mut, constraint = pool_native.owner == *pool_signer.key)]
+    pub pool_native: Box<Account<'info, TokenAccount>>,


I don't know why the boxing of all accounts are required here

Added IDO Program Milestone Project

6573c1f

acheroncrypto requested changes Jul 1, 2023

View reviewed changes

0xcatrovacer and others added 27 commits July 2, 2023 09:30

Update programs/ido-program/Anchor.toml

25c3dfc

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/migrations/deploy.ts

dadffb5

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/package.json

643279d

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

70ad3a3

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

4e0a1a9

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

7d49dde

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

e25f3a6

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

1a63466

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

50bd967

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

0415361

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

6dd9b88

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

cb7160e

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

c08ed2b

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

3251df7

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

2ae1d08

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

8741820

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

be2ad5c

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

4dc6be5

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

7a6f9bc

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

6209c17

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

dc807e3

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

82905f5

Co-authored-by: acheron <[email protected]>

Update programs/ido-program/programs/ido-program/src/lib.rs

f07e56e

Co-authored-by: acheron <[email protected]>

changes made according to review

817bc89

fixed issues in .md file

eef0351

resolved merge conflicts

464f81e

ran rustfmt

f9f3a9e

resolved merge conflicts

caa3d0d

buffalojoec reviewed Jul 3, 2023

View reviewed changes

acheroncrypto reviewed Jul 3, 2023

View reviewed changes

0xcatrovacer added 2 commits July 5, 2023 00:09

made necessary changes to the programs according to review

51b242d

made necessary changes to the content

e1345ad

Aursen reviewed Jul 21, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added IDO Program Milestone Project #85

Added IDO Program Milestone Project #85

0xcatrovacer commented Jun 26, 2023 •

edited

Loading

buffalojoec commented Jun 26, 2023

acheroncrypto left a comment

buffalojoec Jul 3, 2023

acheroncrypto Jul 3, 2023

buffalojoec Jul 3, 2023

0xcatrovacer Jul 4, 2023

buffalojoec Jul 3, 2023

acheroncrypto left a comment

acheroncrypto Jul 3, 2023

acheroncrypto Jul 3, 2023

acheroncrypto Jul 3, 2023

0xcatrovacer Jul 4, 2023

0xcatrovacer commented Jul 4, 2023

Aursen left a comment

Aursen Jul 21, 2023

Aursen Jul 21, 2023

Aursen Jul 21, 2023

Aursen Jul 21, 2023

Aursen Jul 21, 2023


		This program will be doing a couple of things. In an IDO, a project distributes its native tokens among willing investors. There are a few types of IDOs which are done. We will be implementing a fair launch IDO platform. In here, a project escrows the native tokens into a pool. When the IDO opens, investors come and deposit their fiat tokens into the pool. After the IDO is over, investors can claim their native tokens, the amount of which is calculated by the the pool percentage share of their deposit. The project can also finally withdraw all the deposited fiat tokens.

		We recommend keeping programs in a single `lib.rs` file.

Added IDO Program Milestone Project #85

Are you sure you want to change the base?

Added IDO Program Milestone Project #85

Conversation

0xcatrovacer commented Jun 26, 2023 • edited Loading

buffalojoec commented Jun 26, 2023

acheroncrypto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

acheroncrypto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xcatrovacer commented Jul 4, 2023

Aursen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xcatrovacer commented Jun 26, 2023 •

edited

Loading