Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tokens and Nfts - Updated token-program-advanced lesson #488

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Tokens and Nfts - Updated token-program-advanced lesson #488

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbbbe61
changed return type and added extra code for revoke delegates
ubadineke Sep 16, 2024
45c71c5
added top async function and explorer links to view transactions
ubadineke Sep 16, 2024
45df831
fixed prettier issue
ubadineke Sep 16, 2024
3ebd112
removed top level async and added filename info
ubadineke Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
192 changes: 125 additions & 67 deletions content/courses/tokens-and-nfts/token-program-advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Under the hood, the `burn` function creates a transaction with instructions
obtained from the `createBurnInstruction` function:

```typescript
import { PublicKey, Transaction } from "@solana/web3";
import { PublicKey, Transaction } from "@solana/web3.js";
import { createBurnInstruction } from "@solana/spl-token";

async function buildBurnTransaction(
Expand Down Expand Up @@ -105,15 +105,15 @@ Under the hood, the `approve` function creates a transaction with instructions
obtained from the `createApproveInstruction` function:

```typescript
import { PublicKey, Transaction } from "@solana/web3";
import { PublicKey, Transaction } from "@solana/web3.js";
import { createApproveInstruction } from "@solana/spl-token";

async function buildApproveTransaction(
account: PublicKey,
delegate: PublicKey,
owner: PublicKey,
amount: number,
): Promise<web3.Transaction> {
): Promise<Transaction> {
const transaction = new Transaction().add(
createApproveInstruction(account, delegate, owner, amount),
);
Expand Down Expand Up @@ -150,13 +150,13 @@ Under the hood, the `revoke` function creates a transaction with instructions
obtained from the `createRevokeInstruction` function:

```typescript
import { PublicKey, Transaction } from "@solana/web3";
import { PublicKey, Transaction } from "@solana/web3.js";
import { revoke } from "@solana/spl-token";

async function buildRevokeTransaction(
account: PublicKey,
owner: PublicKey,
): Promise<web3.Transaction> {
): Promise<Transaction> {
const transaction = new Transaction().add(
createRevokeInstruction(account, owner),
);
Expand Down Expand Up @@ -210,59 +210,109 @@ const delegate = new PublicKey("YOUR_DELEGATE_HERE");
// Substitute in your token mint account
const tokenMintAccount = new PublicKey("YOUR_TOKEN_MINT_ADDRESS_HERE");

// Get or create the source and destination token accounts to store this token
const sourceTokenAccount = await getOrCreateAssociatedTokenAccount(
connection,
user,
tokenMintAccount,
user.publicKey,
);
(async () => {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to add this, in fact you were instructed to remove it: https://github.com/solana-foundation/developer-content/blob/main/CONTRIBUTING.md#jsts

Also add filesname= to the code snippets. See https://github.com/solana-foundation/developer-content/blob/main/CONTRIBUTING.md#file-names

// Get or create the source and destination token accounts to store this token
const sourceTokenAccount = await getOrCreateAssociatedTokenAccount(
connection,
user,
tokenMintAccount,
user.publicKey,
);

// Our token has two decimal places
const MINOR_UNITS_PER_MAJOR_UNITS = Math.pow(10, 2);
// Our token has two decimal places
const MINOR_UNITS_PER_MAJOR_UNITS = Math.pow(10, 2);

const approveTransactionSignature = await approve(
connection,
user,
sourceTokenAccount.address,
delegate,
user.publicKey,
50 * MINOR_UNITS_PER_MAJOR_UNITS,
);
const approveTransactionSignature = await approve(
connection,
user,
sourceTokenAccount.address,
delegate,
user.publicKey,
50 * MINOR_UNITS_PER_MAJOR_UNITS,
);

console.log(
`Approve Delegate Transaction: ${getExplorerLink(
"transaction",
approveTransactionSignature,
"devnet",
)}`,
);
console.log(
✅`Approve Delegate Transaction: ${getExplorerLink(
"transaction",
approveTransactionSignature,
"devnet",
)}`,
);
})();
```

Run the script using `npx esrun delegate-tokens.ts`. You should see:

```bash
✅ Approve Delegate Transaction: https://explorer.solana.com/tx/31zsmGuX3NM1ip88mowaHT8B3gKDET3b6QnWSRcs2oWXeu9hgGoJunKmbTXZPF1cjpk2aaymf1wuBn58gAp5Q2h?cluster=devnet
```

#### 2. Revoke Delegate

Lets revoke the `delegate` using the `spl-token` library's `revoke` function.

Revoke will set delegate for the token account to null and reset the delegated
amount to 0.
Revoke will set delegate for the associated token account to null and reset the
delegated amount to 0.

All we will need for this function is the token account and user. After the
Create a new file `revoke-token.ts`

```typescript
const revokeTransactionSignature = await revoke(
connection,
user,
sourceTokenAccount.address,
user.publicKey,
);
import "dotenv/config";
import {
getExplorerLink,
getKeypairFromEnvironment,
} from "@solana-developers/helpers";
import { Connection, PublicKey, clusterApiUrl } from "@solana/web3.js";
import {
approve,
getOrCreateAssociatedTokenAccount,
revoke,
} from "@solana/spl-token";

const connection = new Connection(clusterApiUrl("devnet"));

const user = getKeypairFromEnvironment("SECRET_KEY");

console.log(
`Revoke Delegate Transaction: ${getExplorerLink(
"transaction",
revokeTransactionSignature,
"devnet",
)}`,
`🔑 Loaded our keypair securely, using an env file! Our public key is: ${user.publicKey.toBase58()}`,
);

// Add the delegate public key here.
const delegate = new PublicKey("YOUR_DELEGATE_HERE");

// Substitute in your token mint account
const tokenMintAccount = new PublicKey("YOUR_TOKEN_MINT_ADDRESS_HERE");

(async () => {
// Get or create the source and destination token accounts to store this token
const sourceTokenAccount = await getOrCreateAssociatedTokenAccount(
connection,
user,
tokenMintAccount,
user.publicKey,
);

const revokeTransactionSignature = await revoke(
connection,
user,
sourceTokenAccount.address,
user.publicKey,
);

console.log(
✅`Revoke Delegate Transaction: ${getExplorerLink(
"transaction",
revokeTransactionSignature,
"devnet",
)}`,
);
})();
```

Run the script using `npx esrun revoke-tokens.ts`. You should see:

```bash
✅ Revoke Delegate Transaction: https://explorer.solana.com/tx/2jFgvXeF19nSFzjGLVoKo8vtGBp7xan3UZkRaGEpXHCuhKYerEiaE6a4oWVvJXjjYLNmt76XSx5U23J89moma31H?cluster=devnet
```

#### 3. Burn Tokens
Expand All @@ -272,7 +322,7 @@ Finally, let's remove some tokens from circulation by burning them.
Use the `spl-token` library's `burn` function to remove half of your tokens from
circulation.

Now call this new function in `main` to burn 25 of the user's tokens.
Create a new file `burn-tokens.ts`

```typescript
import "dotenv/config";
Expand All @@ -295,32 +345,40 @@ console.log(
const tokenMintAccount = new PublicKey("YOUR_TOKEN_MINT_ADDRESS_HERE");

// Get the account where the user stores these tokens
const sourceTokenAccount = await getOrCreateAssociatedTokenAccount(
connection,
user,
tokenMintAccount,
user.publicKey,
);
(async () => {
const sourceTokenAccount = await getOrCreateAssociatedTokenAccount(
connection,
user,
tokenMintAccount,
user.publicKey,
);

// Our token has two decimal places
const MINOR_UNITS_PER_MAJOR_UNITS = Math.pow(10, 2);
// Our token has two decimal places
const MINOR_UNITS_PER_MAJOR_UNITS = Math.pow(10, 2);

const transactionSignature = await burn(
connection,
user,
sourceTokenAccount.address,
tokenMintAccount,
user,
25 * MINOR_UNITS_PER_MAJOR_UNITS,
);
const transactionSignature = await burn(
connection,
user,
sourceTokenAccount.address,
tokenMintAccount,
user,
25 * MINOR_UNITS_PER_MAJOR_UNITS,
);

console.log(
`Burn Transaction: ${getExplorerLink(
"transaction",
transactionSignature,
"devnet",
)}`,
);
console.log(
✅`Burn Transaction: ${getExplorerLink(
"transaction",
transactionSignature,
"devnet",
)}`,
);
})();
```

Run the script using `npx esrun burn-tokens.ts`. You should see:

```bash
✅ Burn Transaction: https://explorer.solana.com/tx/29jRrkMsnibmW5tNaxv38bZDe2QioZMeAurPdMvdZiqVA6biwYFcn5wGFgm6YC7bAwBufZFhXz4kh9Avsh1Ggn3u?cluster=devnet
```

Well done! You've now
Expand Down
Loading