Remove supply from Token (#82)

Author: jackcmay

token-swap/inc/token-swap.h

@@ -73,7 +73,6 @@ typedef enum TokenSwap_SwapInstruction_Tag {
      *   0. `[]` Token-swap
      *   1. `[]` $authority
      *   2. `[writable]` SOURCE Pool account, amount is transferable by $authority.
-     *   4. `[writable]` Pool MINT account, $authority is the owner.
      *   5. `[writable]` token_a Account to withdraw FROM.
      *   6. `[writable]` token_b Account to withdraw FROM.
      *   7. `[writable]` token_a user Account.

token-swap/js/cli/token-swap-test.js

@@ -244,7 +244,6 @@ export async function withdraw(): Promise<void> {
   await tokenSwap.withdraw(
     authority,
     tokenAccountPool,
-    tokenPool.publicKey,
     tokenAccountA,
     tokenAccountB,
     userAccountA,

token-swap/js/client/token-swap.js

@@ -453,7 +453,6 @@ export class TokenSwap {
   async withdraw(
     authority: PublicKey,
     sourcePoolAccount: PublicKey,
-    poolToken: PublicKey,
     fromA: PublicKey,
     fromB: PublicKey,
     userAccountA: PublicKey,
@@ -468,7 +467,6 @@ export class TokenSwap {
         this.withdrawInstruction(
           authority,
           sourcePoolAccount,
-          poolToken,
           fromA,
           fromB,
           userAccountA,
@@ -483,7 +481,6 @@ export class TokenSwap {
   withdrawInstruction(
     authority: PublicKey,
     sourcePoolAccount: PublicKey,
-    poolToken: PublicKey,
     fromA: PublicKey,
     fromB: PublicKey,
     userAccountA: PublicKey,
@@ -509,7 +506,6 @@ export class TokenSwap {
       {pubkey: this.tokenSwap, isSigner: false, isWritable: false},
       {pubkey: authority, isSigner: false, isWritable: false},
       {pubkey: sourcePoolAccount, isSigner: false, isWritable: true},
-      {pubkey: poolToken, isSigner: false, isWritable: true},
       {pubkey: fromA, isSigner: false, isWritable: true},
       {pubkey: fromB, isSigner: false, isWritable: true},
       {pubkey: userAccountA, isSigner: false, isWritable: true},

token-swap/src/lib.rs

@@ -80,7 +80,6 @@ pub enum SwapInstruction {
     ///   0. `[]` Token-swap
     ///   1. `[]` $authority
     ///   2. `[writable]` SOURCE Pool account, amount is transferable by $authority.
-    ///   4. `[writable]` Pool MINT account, $authority is the owner.
     ///   5. `[writable]` token_a Account to withdraw FROM.
     ///   6. `[writable]` token_b Account to withdraw FROM.
     ///   7. `[writable]` token_a user Account.
@@ -289,7 +288,6 @@ pub enum State {
 struct Invariant {
     token_a: u64,
     token_b: u64,
-    pool: Option<u64>,
     fee: Fee,
 }
 impl Invariant {
@@ -310,17 +308,6 @@ impl Invariant {
     fn exchange_rate(&self, token_a: u64) -> Option<u64> {
         token_a.checked_mul(self.token_b)?.checked_div(self.token_a)
     }
-    fn redeem(&self, user_pool: u64) -> Option<(u64, u64)> {
-        let token_a = self
-            .token_a
-            .checked_mul(user_pool)?
-            .checked_div(self.pool?)?;
-        let token_b = self
-            .token_b
-            .checked_mul(user_pool)?
-            .checked_div(self.pool?)?;
-        Some((token_a, token_b))
-    }
 }
 
 impl State {
@@ -403,20 +390,13 @@ impl State {
         token_program_id: &Pubkey,
         swap: &Pubkey,
         burn_account: &Pubkey,
-        mint: &Pubkey,
         authority: &Pubkey,
         amount: u64,
     ) -> Result<(), ProgramError> {
         let swap_string = swap.to_string();
         let signers = &[&[&swap_string[..32]][..]];
-        let ix = spl_token::instruction::burn(
-            token_program_id,
-            burn_account,
-            mint,
-            authority,
-            &[],
-            amount,
-        )?;
+        let ix =
+            spl_token::instruction::burn(token_program_id, burn_account, authority, &[], amount)?;
         invoke_signed(&ix, accounts, signers)
     }
 
@@ -500,9 +480,6 @@ impl State {
         if spl_token::option::COption::Some(*authority_info.key) != pool_mint.owner {
             return Err(Error::InvalidOwner.into());
         }
-        if 0 != pool_mint.info.supply {
-            return Err(Error::InvalidSupply.into());
-        }
         if token_b.amount == 0 {
             return Err(Error::InvalidSupply.into());
         }
@@ -573,7 +550,6 @@ impl State {
             token_a: into_token.amount,
             token_b: from_token.amount,
             fee: token_swap.fee,
-            pool: None,
         };
         let output = invariant
             .swap(amount)
@@ -635,7 +611,6 @@ impl State {
             token_a: token_a.amount,
             token_b: token_b.amount,
             fee: token_swap.fee,
-            pool: None,
         };
         let b_amount = invariant
             .exchange_rate(a_amount)
@@ -686,7 +661,6 @@ impl State {
         let swap_info = next_account_info(account_info_iter)?;
         let authority_info = next_account_info(account_info_iter)?;
         let source_info = next_account_info(account_info_iter)?;
-        let pool_info = next_account_info(account_info_iter)?;
         let token_a_info = next_account_info(account_info_iter)?;
         let token_b_info = next_account_info(account_info_iter)?;
         let dest_token_a_info = next_account_info(account_info_iter)?;
@@ -703,23 +677,21 @@ impl State {
         if *token_b_info.key != token_swap.token_b {
             return Err(Error::InvalidInput.into());
         }
-        if *pool_info.key != token_swap.pool_mint {
-            return Err(Error::InvalidInput.into());
-        }
+
         let token_a = Self::token_account_deserialize(token_a_info)?;
         let token_b = Self::token_account_deserialize(token_b_info)?;
-        let pool_token = Self::token_deserialize(pool_info)?;
 
         let invariant = Invariant {
             token_a: token_a.amount,
             token_b: token_b.amount,
             fee: token_swap.fee,
-            pool: Some(pool_token.info.supply),
         };
 
-        let (a_amount, b_amount) = invariant
-            .redeem(amount)
+        let a_amount = amount;
+        let b_amount = invariant
+            .exchange_rate(a_amount)
             .ok_or_else(|| Error::CalculationFailure)?;
+
         Self::token_transfer(
             accounts,
             token_program_info.key,
@@ -743,7 +715,6 @@ impl State {
             token_program_info.key,
             swap_info.key,
             source_info.key,
-            pool_info.key,
             authority_info.key,
             amount,
         )?;
@@ -827,7 +798,7 @@ mod tests {
         account::Account, account_info::create_is_signer_account_infos, instruction::Instruction,
     };
     use spl_token::{
-        instruction::{initialize_account, initialize_mint, TokenInfo},
+        instruction::{initialize_account, initialize_mint},
         state::State as SplState,
     };
 
@@ -863,7 +834,7 @@ mod tests {
     fn mint_token(
         program_id: &Pubkey,
         authority_key: &Pubkey,
-        supply: u64,
+        amount: u64,
     ) -> ((Pubkey, Account), (Pubkey, Account)) {
         let token_key = pubkey_rand();
         let mut token_account = Account::new(0, size_of::<SplState>(), &program_id);
@@ -887,13 +858,11 @@ mod tests {
                 &token_key,
                 Some(&account_key),
                 Some(&authority_key),
-                TokenInfo {
-                    supply,
-                    decimals: 2,
-                },
+                amount,
+                2,
             )
             .unwrap(),
-            if supply == 0 {
+            if amount == 0 {
                 vec![&mut token_account, &mut authority_account]
             } else {
                 vec![

token/inc/token.h

@@ -17,20 +17,6 @@
  */
 #define Token_MIN_SIGNERS 1
 
-/**
- * Specifies the financial specifics of a token.
- */
-typedef struct Token_TokenInfo {
-    /**
-     * Total supply of tokens.
-     */
-    uint64_t supply;
-    /**
-     * Number of base 10 digits to the right of the decimal place in the total supply.
-     */
-    uint64_t decimals;
-} Token_TokenInfo;
-
 /**
  * Instructions supported by the token program.
  */
@@ -186,9 +172,13 @@ typedef enum Token_TokenInstruction_Tag {
 
 typedef struct Token_InitializeMint_Body {
     /**
-     * The financial specifics of the token.
+     * Initial amount of tokens to mint.
      */
-    Token_TokenInfo info;
+    uint64_t amount;
+    /**
+     * Number of base 10 digits to the right of the decimal place.
+     */
+    uint8_t decimals;
 } Token_InitializeMint_Body;
 
 typedef struct Token_InitializeMultisig_Body {
@@ -271,16 +261,16 @@ typedef struct Token_COption_Pubkey {
  * matching types my inter-opt.
  */
 typedef struct Token_Token {
-    /**
-     * Token details.
-     */
-    Token_TokenInfo info;
     /**
      * Optional owner, used to mint new tokens.  The owner may only
      * be provided during mint creation.  If no owner is present then the mint
      * has a fixed supply and no further tokens may be minted.
      */
     Token_COption_Pubkey owner;
+    /**
+     * Number of base 10 digits to the right of the decimal place.
+     */
+    uint8_t decimals;
 } Token_Token;
 
 /**

token/js/cli/token-test.js

@@ -120,7 +120,6 @@ export async function createMint(): Promise<void> {
   );
 
   const mintInfo = await testToken.getMintInfo();
-  assert(mintInfo.supply.toNumber() == 10000);
   assert(mintInfo.decimals == 2);
   assert(mintInfo.owner == null);
 
@@ -264,7 +263,6 @@ export async function mintTo(): Promise<void> {
 
   {
     const mintInfo = await testMintableToken.getMintInfo();
-    assert(mintInfo.supply.toNumber() == 10000);
     assert(mintInfo.decimals == 2);
     if (mintInfo.owner === null) {
       throw new Error('owner should not be null');
@@ -285,7 +283,6 @@ export async function mintTo(): Promise<void> {
 
   {
     const mintInfo = await testMintableToken.getMintInfo();
-    assert(mintInfo.supply.toNumber() == 10042);
     assert(mintInfo.decimals == 2);
     if (mintInfo.owner === null) {
       throw new Error('owner should not be null');
@@ -303,16 +300,12 @@ export async function mintTo(): Promise<void> {
 }
 
 export async function burn(): Promise<void> {
-  let mintInfo = await testToken.getMintInfo();
-  const supply = mintInfo.supply.toNumber();
   let accountInfo = await testToken.getAccountInfo(testAccount);
   const amount = accountInfo.amount.toNumber();
 
   await testToken.burn(testAccount, testAccountOwner, [], 1);
   await sleep(500);
 
-  mintInfo = await testToken.getMintInfo();
-  assert(mintInfo.supply.toNumber() == supply - 1);
   accountInfo = await testToken.getAccountInfo(testAccount);
   assert(accountInfo.amount.toNumber() == amount - 1);
 }

token/js/client/token.js

@@ -57,11 +57,6 @@ export class TokenAmount extends BN {
  * Information about the mint
  */
 type MintInfo = {|
-  /**
-   * Total supply of tokens
-   */
-  supply: TokenAmount,
-
   /**
    * Number of base 10 digits to the right of the decimal place
    */
@@ -74,11 +69,11 @@ type MintInfo = {|
 
 const MintLayout = BufferLayout.struct([
   BufferLayout.u8('state'),
-  Layout.uint64('supply'),
-  BufferLayout.nu64('decimals'),
   BufferLayout.u32('option'),
   Layout.publicKey('owner'),
-  BufferLayout.nu64('padding'),
+  BufferLayout.u8('decimals'),
+  BufferLayout.u16('padding1'),
+  BufferLayout.nu64('padding2'),
 ]);
 
 /**
@@ -258,10 +253,11 @@ export class Token {
    *
    * @param connection The connection to use
    * @param owner User account that will own the returned account
-   * @param supply Total supply of the new mint
+   * @param supply Initial supply to mint
    * @param decimals Location of the decimal place
    * @param programId Optional token programId, uses the system programId by default
-   * @return Token object for the newly minted token, Public key of the account holding the total supply of new tokens
+   * @return Token object for the newly minted token, Public key of the account
+   *         holding the total amount of new tokens
    */
   static async createMint(
     connection: Connection,
@@ -303,7 +299,7 @@ export class Token {
     const commandDataLayout = BufferLayout.struct([
       BufferLayout.u8('instruction'),
       Layout.uint64('supply'),
-      BufferLayout.nu64('decimals'),
+      BufferLayout.u8('decimals'),
     ]);
     let data = Buffer.alloc(1024);
     {
@@ -482,7 +478,6 @@ export class Token {
     if (mintInfo.state !== 1) {
       throw new Error(`Invalid account data`);
     }
-    mintInfo.supply = TokenAmount.fromBuffer(mintInfo.supply);
     if (mintInfo.option === 0) {
       mintInfo.owner = null;
     } else {
@@ -1029,7 +1024,6 @@ export class Token {
 
     let keys = [
       {pubkey: account, isSigner: false, isWritable: true},
-      {pubkey: this.publicKey, isSigner: false, isWritable: true},
     ];
     if (authority instanceof Account) {
       keys.push({pubkey: authority.publicKey, isSigner: true, isWritable: false});