Rework token program (#108)

* nudge

Add integration test

* add test and convert to SimpleSerde

* rewrite account handling

* cleanup

* nudge

* Optimize serialization

* C Representation structures

* add test coverage

* No output when running program test

* Respect rent

* update package-lock

* Point to git, update npm scripts

Author: jackcmay

package.json

@@ -6,6 +6,7 @@
     "type": "git",
     "url": "https://github.com/solana-labs/example-token"
   },
+  "testnetDefaultChannel": "beta",
   "scripts": {
     "start": "babel-node src/cli/main.js",
     "lint": "npm run pretty && eslint .",
@@ -15,7 +16,9 @@
     "lint:watch": "watch 'npm run lint:fix' . --wait=1",
     "bpf-sdk:update": "node_modules/@solana/web3.js/bin/bpf-sdk-install.sh",
     "build:program": "./src/program/do.sh build",
-    "clean:program": "./src/program/do.sh clean",
+    "clean:program": "./src/program/do.sh clean && cargo clean --manifest-path ./src/program-test/Cargo.toml",
+    "test:program": "./src/program/do.sh test",
+    "bench:program": "npm run build:program && cargo test --manifest-path ./src/program-test/Cargo.toml -- --nocapture",
     "localnet:update": "solana-localnet update",
     "localnet:up": "set -x; solana-localnet down; set -e; solana-localnet up",
     "localnet:down": "solana-localnet down",

src/cli/main.js

@@ -28,9 +28,9 @@ async function main() {
   await approveRevoke();
   console.log('Run test: invalidApprove');
   await invalidApprove();
-  console.log('Run test: loadTokenProgram');
+  console.log('Run test: failOnApproveOverspend');
   await failOnApproveOverspend();
-  console.log('Run test: failOnApproveOverspends');
+  console.log('Run test: setOwner');
   await setOwner();
   console.log('Success\n');
 }

src/cli/token-test.js

@@ -60,33 +60,33 @@ export async function loadTokenProgram(): Promise<void> {
   );
   const connection = await getConnection();
   const [, feeCalculator] = await connection.getRecentBlockhash();
-  const fees =
+  const balanceNeeded =
     feeCalculator.lamportsPerSignature *
-    (BpfLoader.getMinNumSignatures(data.length) + NUM_RETRIES);
-  const from = await newAccountWithLamports(connection, fees);
+      (BpfLoader.getMinNumSignatures(data.length) + NUM_RETRIES) +
+    (await connection.getMinimumBalanceForRentExemption(data.length));
 
-  console.log('Loading Token program, may take a bit...');
+  const from = await newAccountWithLamports(connection, balanceNeeded);
+  console.log('Loading Token program...');
   programId = await BpfLoader.load(connection, from, data);
 }
 
 export async function createNewToken(): Promise<void> {
   const connection = await getConnection();
-  initialOwner = await newAccountWithLamports(connection, 1024);
+  const balanceNeeded =
+    (await Token.getMinBalanceRentForExemptToken(connection)) +
+    (await Token.getMinBalanceRentForExemptTokenAccount(connection));
+  initialOwner = await newAccountWithLamports(connection, balanceNeeded);
   [testToken, initialOwnerTokenAccount] = await Token.createNewToken(
     connection,
     initialOwner,
     new TokenAmount(10000),
-    'Test token',
-    'TEST',
     2,
     programId,
   );
 
   const tokenInfo = await testToken.tokenInfo();
   assert(tokenInfo.supply.toNumber() == 10000);
   assert(tokenInfo.decimals == 2);
-  assert(tokenInfo.name == 'Test token');
-  assert(tokenInfo.symbol == 'TEST');
 
   const accountInfo = await testToken.accountInfo(initialOwnerTokenAccount);
   assert(accountInfo.token.equals(testToken.token));
@@ -98,7 +98,10 @@ export async function createNewToken(): Promise<void> {
 
 export async function createNewTokenAccount(): Promise<void> {
   const connection = await getConnection();
-  const destOwner = await newAccountWithLamports(connection);
+  const balanceNeeded = await Token.getMinBalanceRentForExemptTokenAccount(
+    connection,
+  );
+  const destOwner = await newAccountWithLamports(connection, balanceNeeded);
   const dest = await testToken.newAccount(destOwner);
   const accountInfo = await testToken.accountInfo(dest);
   assert(accountInfo.token.equals(testToken.token));
@@ -109,7 +112,10 @@ export async function createNewTokenAccount(): Promise<void> {
 
 export async function transfer(): Promise<void> {
   const connection = await getConnection();
-  const destOwner = await newAccountWithLamports(connection);
+  const balanceNeeded = await Token.getMinBalanceRentForExemptTokenAccount(
+    connection,
+  );
+  const destOwner = await newAccountWithLamports(connection, balanceNeeded);
   const dest = await testToken.newAccount(destOwner);
 
   await testToken.transfer(initialOwner, initialOwnerTokenAccount, dest, 123);
@@ -126,7 +132,10 @@ export async function approveRevoke(): Promise<void> {
   }
 
   const connection = await getConnection();
-  const delegateOwner = await newAccountWithLamports(connection);
+  const balanceNeeded = await Token.getMinBalanceRentForExemptTokenAccount(
+    connection,
+  );
+  const delegateOwner = await newAccountWithLamports(connection, balanceNeeded);
   const delegate = await testToken.newAccount(
     delegateOwner,
     initialOwnerTokenAccount,
@@ -161,7 +170,9 @@ export async function approveRevoke(): Promise<void> {
 
 export async function invalidApprove(): Promise<void> {
   const connection = await getConnection();
-  const owner = await newAccountWithLamports(connection);
+  const balanceNeeded =
+    (await Token.getMinBalanceRentForExemptTokenAccount(connection)) * 3;
+  const owner = await newAccountWithLamports(connection, balanceNeeded);
   const account1 = await testToken.newAccount(owner);
   const account1Delegate = await testToken.newAccount(owner, account1);
   const account2 = await testToken.newAccount(owner);
@@ -174,7 +185,9 @@ export async function invalidApprove(): Promise<void> {
 
 export async function failOnApproveOverspend(): Promise<void> {
   const connection = await getConnection();
-  const owner = await newAccountWithLamports(connection);
+  const balanceNeeded =
+    (await Token.getMinBalanceRentForExemptTokenAccount(connection)) * 3;
+  const owner = await newAccountWithLamports(connection, balanceNeeded);
   const account1 = await testToken.newAccount(owner);
   const account1Delegate = await testToken.newAccount(owner, account1);
   const account2 = await testToken.newAccount(owner);
@@ -209,8 +222,11 @@ export async function failOnApproveOverspend(): Promise<void> {
 
 export async function setOwner(): Promise<void> {
   const connection = await getConnection();
-  const owner = await newAccountWithLamports(connection);
-  const newOwner = await newAccountWithLamports(connection);
+  const balanceNeeded = await Token.getMinBalanceRentForExemptTokenAccount(
+    connection,
+  );
+  const owner = await newAccountWithLamports(connection, balanceNeeded);
+  const newOwner = await newAccountWithLamports(connection, balanceNeeded);
   const account = await testToken.newAccount(owner);
 
   await testToken.setOwner(owner, account, newOwner.publicKey);

src/client/token.js

@@ -65,26 +65,15 @@ type TokenInfo = {|
    * Number of base 10 digits to the right of the decimal place
    */
   decimals: number,
-
-  /**
-   * Descriptive name of this token
-   */
-  name: string,
-
-  /**
-   * Symbol for this token
-   */
-  symbol: string,
 |};
 
 /**
  * @private
  */
 const TokenInfoLayout = BufferLayout.struct([
+  BufferLayout.u8('state'),
   Layout.uint64('supply'),
   BufferLayout.u8('decimals'),
-  Layout.rustString('name'),
-  Layout.rustString('symbol'),
 ]);
 
 /**
@@ -126,10 +115,11 @@ type TokenAccountInfo = {|
  * @private
  */
 const TokenAccountInfoLayout = BufferLayout.struct([
+  BufferLayout.u8('state'),
   Layout.publicKey('token'),
   Layout.publicKey('owner'),
   Layout.uint64('amount'),
-  BufferLayout.u8('sourceOption'),
+  BufferLayout.nu64('sourceOption'),
   Layout.publicKey('source'),
   Layout.uint64('originalAmount'),
 ]);
@@ -166,14 +156,38 @@ export class Token {
     Object.assign(this, {connection, token, programId});
   }
 
+  /**
+   * Get the minimum balance for the token to be rent exempt
+   *
+   * @return Number of lamports required
+   */
+  static async getMinBalanceRentForExemptToken(
+    connection: Connection,
+  ): Promise<number> {
+    return await connection.getMinimumBalanceForRentExemption(
+      TokenInfoLayout.span,
+    );
+  }
+
+  /**
+   * Get the minimum balance for the token account to be rent exempt
+   *
+   * @return Number of lamports required
+   */
+  static async getMinBalanceRentForExemptTokenAccount(
+    connection: Connection,
+  ): Promise<number> {
+    return await connection.getMinimumBalanceForRentExemption(
+      TokenAccountInfoLayout.span,
+    );
+  }
+
   /**
    * Create a new Token
    *
    * @param connection The connection to use
    * @param owner User account that will own the returned Token Account
    * @param supply Total supply of the new token
-   * @param name Descriptive name of this token
-   * @param symbol Symbol for this token
    * @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 Token Account holding the total supply of new tokens
@@ -182,8 +196,6 @@ export class Token {
     connection: Connection,
     owner: Account,
     supply: TokenAmount,
-    name: string,
-    symbol: string,
     decimals: number,
     programId: PublicKey,
   ): Promise<TokenAndPublicKey> {
@@ -194,11 +206,9 @@ export class Token {
     let transaction;
 
     const dataLayout = BufferLayout.struct([
-      BufferLayout.u32('instruction'),
+      BufferLayout.u8('instruction'),
       Layout.uint64('supply'),
-      BufferLayout.u8('decimals'),
-      Layout.rustString('name'),
-      Layout.rustString('symbol'),
+      BufferLayout.nu64('decimals'),
     ]);
 
     let data = Buffer.alloc(1024);
@@ -208,19 +218,21 @@ export class Token {
           instruction: 0, // NewToken instruction
           supply: supply.toBuffer(),
           decimals,
-          name,
-          symbol,
         },
         data,
       );
       data = data.slice(0, encodeLength);
     }
 
+    const balanceNeeded = await Token.getMinBalanceRentForExemptToken(
+      connection,
+    );
+
     // Allocate memory for the tokenAccount account
     transaction = SystemProgram.createAccount(
       owner.publicKey,
       tokenAccount.publicKey,
-      1,
+      balanceNeeded,
       1 + data.length,
       programId,
     );
@@ -268,7 +280,7 @@ export class Token {
     const tokenAccount = new Account();
     let transaction;
 
-    const dataLayout = BufferLayout.struct([BufferLayout.u32('instruction')]);
+    const dataLayout = BufferLayout.struct([BufferLayout.u8('instruction')]);
 
     const data = Buffer.alloc(dataLayout.span);
     dataLayout.encode(
@@ -278,12 +290,16 @@ export class Token {
       data,
     );
 
+    const balanceNeeded = await Token.getMinBalanceRentForExemptTokenAccount(
+      this.connection,
+    );
+
     // Allocate memory for the token
     transaction = SystemProgram.createAccount(
       owner.publicKey,
       tokenAccount.publicKey,
-      1,
-      1 + TokenAccountInfoLayout.span,
+      balanceNeeded,
+      TokenAccountInfoLayout.span,
       this.programId,
     );
     await sendAndConfirmTransaction(
@@ -332,10 +348,10 @@ export class Token {
 
     const data = Buffer.from(accountInfo.data);
 
-    if (data.readUInt8(0) !== 1) {
-      throw new Error(`Invalid token data`);
+    const tokenInfo = TokenInfoLayout.decode(data);
+    if (tokenInfo.state !== 1) {
+      throw new Error(`Invalid token account data`);
     }
-    const tokenInfo = TokenInfoLayout.decode(data, 1);
     tokenInfo.supply = TokenAmount.fromBuffer(tokenInfo.supply);
     return tokenInfo;
   }
@@ -352,11 +368,11 @@ export class Token {
     }
 
     const data = Buffer.from(accountInfo.data);
-    if (data.readUInt8(0) !== 2) {
+    const tokenAccountInfo = TokenAccountInfoLayout.decode(data);
+
+    if (tokenAccountInfo.state !== 2) {
       throw new Error(`Invalid token account data`);
     }
-    const tokenAccountInfo = TokenAccountInfoLayout.decode(data, 1);
-
     tokenAccountInfo.token = new PublicKey(tokenAccountInfo.token);
     tokenAccountInfo.owner = new PublicKey(tokenAccountInfo.owner);
     tokenAccountInfo.amount = TokenAmount.fromBuffer(tokenAccountInfo.amount);
@@ -490,7 +506,7 @@ export class Token {
     }
 
     const dataLayout = BufferLayout.struct([
-      BufferLayout.u32('instruction'),
+      BufferLayout.u8('instruction'),
       Layout.uint64('amount'),
     ]);
 
@@ -537,7 +553,7 @@ export class Token {
     amount: number | TokenAmount,
   ): TransactionInstruction {
     const dataLayout = BufferLayout.struct([
-      BufferLayout.u32('instruction'),
+      BufferLayout.u8('instruction'),
       Layout.uint64('amount'),
     ]);
 
@@ -588,7 +604,7 @@ export class Token {
     account: PublicKey,
     newOwner: PublicKey,
   ): TransactionInstruction {
-    const dataLayout = BufferLayout.struct([BufferLayout.u32('instruction')]);
+    const dataLayout = BufferLayout.struct([BufferLayout.u8('instruction')]);
 
     const data = Buffer.alloc(dataLayout.span);
     dataLayout.encode(

src/client/util/new-account-with-lamports.js

@@ -20,7 +20,7 @@ export async function newAccountWithLamports(
     if (--retries <= 0) {
       break;
     }
-    console.log('Airdrop retry ' +  retries);
+    console.log('Airdrop retry ' + retries);
   }
   throw new Error(`Airdrop of ${lamports} failed`);
 }

src/program-test/.gitignore

@@ -0,0 +1 @@
+/target/