> For the complete documentation index, see [llms.txt](https://phunks.gitbook.io/knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://phunks.gitbook.io/knowledge-base/built-by-phunks/for-the-pham/phunkbot/tutorials.md).

# TUTORIALS

## <mark style="color:yellow;">`Getting started`</mark>

<details>

<summary>THINGS YOU WILL NEED</summary>

* Linux Server ([ubuntu 20.04](https://www.vultr.com/products/cloud-compute/)).
* Twitter [v2 API access](https://developer.twitter.com/en/docs/twitter-api/getting-started/about-twitter-api).
* Alchemy [API Key](https://auth.alchemy.com/signup).
* [Node.js](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04) v18.x
* Discord [APP token](https://discord.com/developers).
* Discord Server **Admin** access.
* Some Basic coding/editing knowledge.

</details>

***

## <mark style="color:yellow;">`Prerequisite`</mark>

<details>

<summary>ACCOUNTS AND ACCESS TOKENS</summary>

#### TWITTER

* To get your twitter API keys, follow this [tutorial](https://developer.talkwalker.com/guides/rehydrating-tweet/getting-started).
* Now you need Access keys with **read and write** permission, follow this [tutorial](https://docs.tibco.com/pub/activematrix_businessworks_plugin_for_twitter/6.1.0/doc/html/GUID-3FAC9352-94BE-4D21-9DAC-7AE79E24BECA.html).
* Save both, your API and Access keys for [deployment](#deployment).
* (optional) to obtain Access keys of another User, follow this [tutorial](https://developer.twitter.com/en/docs/tutorials/authenticating-with-twitter-api-for-enterprise/oauth1-0a-and-user-access-tokens).

***

#### DISCORD

* To get Discord bot token, follow this [tutorial](https://www.writebots.com/discord-bot-token/).
* Save your Discord token for [deployment](#deployment).
* Now you will need to generate link with proper permissions to invite your Discord bot to your Server. In your [developer portal](https://discord.com/developers) under `0Auth2/URL Generator` check this boxes:

<img src="/files/goLB3NdtXtrUyUwTYnU1" alt="" data-size="original">

This will generate URL that you can use to invite Bot to your Discord server with proper permissions for it to post sales and other [Application Commands](#stats-commands).

<mark style="background-color:orange;">Discord bot should now be ready to post sales, if you get stuck dm me on twitter @iape\_</mark>

</details>

***

## <mark style="color:yellow;">`Deployment`</mark>

<details>

<summary>INSTALLATION</summary>

On your ubuntu server first clone PhunkBot repository

```bash
git clone https://github.com/Crypto-Phunks/nft-sales-twitter-bot.git
```

Go to Bots directory

```bash
cd nft-sales-twitter-bot
```

***

#### Run installation

```bash
npm install
```

***

#### Create `.env` file

```bash
nano .env
```

Add content from `example.env` and enter your [API](#prerequisite) credentials

{% code title=".env" overflow="wrap" %}

```bash
TWITTER_ACCESS_TOKEN_KEY=""
TWITTER_ACCESS_TOKEN_SECRET=""
TWITTER_API_KEY=""
TWITTER_API_KEY_SECRET=""

ALCHEMY_API_KEY=""
DISCORD_TOKEN=""

GETH_NODE_ENDPOINT=""
GETH_NODE_ENDPOINT_HTTP=""
```

{% endcode %}

***

Edit the <mark style="color:orange;">`src/config.ts`</mark> file

```bash
nano src/config.ts
```

Add your Smart Contract and Discord IDs

{% code title="config.ts" %}

```typescript
  // Contract Address ======================================== //
  contract_address: 'your-NFT-smart-contract',
  nftx_vault_contract_address: '',
  // Enter the block where your contract has been created
  statistic_initial_block: 13035326,
  //
  discord_channels: 'your-discord-channel-ID-where-bot-posts-sales',
  discord_client_id: 'your-discord-APP-ID',
  discord_guild_ids: 'your-discord-Server-ID',
```

{% endcode %}

Customise the Tweet and Discord Stats parameters

{% code title="config.ts" %}

```typescript
  ownedTokensMessageDiscord: '<wallet> owns <count> Phunks!\n———\n',
  graphStatisticsMessageDiscord: 'Here is the graph you requested for [<wallet>]!\n———\n',
  userStatisticsMessageDiscord: 'Stats for <wallet>!\n———\n\n⏳ Flipped to Phunk for the first time [<holder_since>] days ago.\n💰 Flipped Phunks [<tx_count>] times with a total volume of [Ξ<volume>]\n💎 Is currently holding [<owned_tokens>] Phunks.',
  globalStatisticsMessageDiscord: 'Here are volume stats for [<window>]! 💰\n\n<per_platform_stats>\n\nlast tx fetched [<last_event>]',
  saleMessageDiscord: '[Phunk #<tokenId>](<tweetLink>) was flipped for [<ethPrice> (<fiatPrice>)](<https://etherscan.io/tx/<txHash>>)\nfrom: [<from>](<https://notlarvalabs.com/cryptophunks/phunkbox?address=<initialFrom>>)\nto: [<to>](<https://notlarvalabs.com/cryptophunks/phunkbox?address=<initialTo>>)',
  saleMessage: 'Phunk #<tokenId> was flipped for <ethPrice> (<fiatPrice>) by <to>\n| https://notlarvalabs.com/cryptophunks/details/<tokenId>\n',
  bidMessageDiscord: '[Phunk #<tokenId>](<tweetLink>) has a bid for [<ethPrice> (<fiatPrice>)](https://notlarvalabs.com/cryptophunks/details/<tokenId>)\nfrom: [<from>](<https://notlarvalabs.com/cryptophunks/phunkbox?address=<initialFrom>>)',
  bidMessage: 'Phunk #<tokenId> has a bid for <ethPrice> (<fiatPrice>) from <from>\n| https://notlarvalabs.com/cryptophunks/details/<tokenId>\n',
  flywheelMessageDiscord: '[Phunk #<tokenId>](<tweetLink>) was flipped to FlyWheel for [<ethPrice> (<fiatPrice>)](<https://etherscan.io/tx/<txHash>>)\nby: [<to>](<https://notlarvalabs.com/cryptophunks/phunkbox?address=<initialTo>>)',
  flywheelMessage: 'Phunk #<tokenId> was flipped to FlyWheel for <ethPrice> (<fiatPrice>) by <to>\n| https://notlarvalabs.com/cryptophunks/details/<tokenId>\n| https://phunks.pro',
  auctionMessageDiscord: '[Phunk #<tokenId>](<tweetLink>) was Auctioned for [<ethPrice> (<fiatPrice>)](<additionalText>)\nto: [<to>](<https://notlarvalabs.com/cryptophunks/phunkbox?address=<initialTo>>)',
  auctionMessage: 'Phunk #<tokenId> was Auctioned for <ethPrice> (<fiatPrice>) to <to>\n| https://notlarvalabs.com/cryptophunks/details/<tokenId>\n| <additionalText>',
  loanMessage: 'Phunk #<tokenId> was flipped for <ethPrice> (<fiatPrice>) by <to>\n| https://notlarvalabs.com/cryptophunks/details/<tokenId>\n',
```

{% endcode %}

(Optional) Use Local images and Local metadata

{% code title="config.ts" %}

```typescript
  use_local_images: true,
  local_image_path: './token_images/phunk',
  use_forced_remote_image_path: false,
  forced_remote_image_path: '',
  enable_flashbot_detection: false,
  // 
  // this is a configuration for the phunk bid demo extension
  local_bids_image_path: './bids_images/Phunk_',
  discord_owned_tokens_image_path: '',
  discord_footer_text: 'FLIP!',
  // this is a configuration for the phunk auction house demo extension
  local_auction_image_path: './token_images/phunk',
  token_metadata_cache_path: './token_metadatas_cache',
```

{% endcode %}

The <mark style="color:orange;">`local_image_path`</mark> will be suffixed with the token number, ie, here, it will seek for an image named <mark style="color:red;">`./token_images/tokens0034.png`</mark> if the token #34 is sold.

***

(Optional) Edit <mark style="color:orange;">`src/app.module.ts`</mark>file and activate/deactivate services (providers) //&#x20;

<pre class="language-typescript" data-title="app.module.ts"><code class="lang-typescript">@Module({
  imports: [
    HttpModule,
    ServeStaticModule.forRoot({
      rootPath: join(__dirname, '..', 'client'),
    })],
    providers: [
      Erc721SalesService,
      <a data-footnote-ref href="#user-content-fn-1">// DAOService, -> This is DAO Service </a>
      <a data-footnote-ref href="#user-content-fn-2">// StatisticsService, -> This is Statistics Service</a>
      ////
      // Below is a simple example of how to create and plug a custom 
      // extension to the bot
      ////
      //
      PhunksBidService,
      PhunksAuctionHouseService,
      PhunksAuctionFlywheelService, 
      StatisticsService
    ],
    controllers: [
      DAOController
    ],
})

export class AppModule {

}
</code></pre>

***

#### Build and Deploy

```bash
npm run build
```

<mark style="background-color:orange;">Installation should be ready now, proceed to</mark> [<mark style="background-color:orange;">next step</mark>](#running-bot)<mark style="background-color:orange;">.</mark>

</details>

***

## <mark style="color:yellow;">`Running Bot`</mark>

<details>

<summary>START</summary>

From my experience i recommend you run [screen](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-screen-on-an-ubuntu-cloud-server) Session for your Bots instance.&#x20;

#### within installation directory start a new screen Session

```bash
screen -S yourbotsname
```

***

Now you can finally Start a bot, here are few run modes possible:

#### development

```bash
npm run start
```

#### watch mode

```bash
npm run start:dev
```

#### production mode

```bash
npm run start:prod
```

#### with watchdog (<mark style="color:green;">recommended</mark>)

```bash
npm run start:prod-with-watchdog
```

***

#### detach from screen Session

```bash
ctrl a + d
```

#### enter the screen Session back

```bash
screen -r yourbotsname
```

</details>

***

## <mark style="color:yellow;">`Stats Commands`</mark>

<details>

<summary>ON DISCORD</summary>

If you have [Statistics module](/knowledge-base/built-by-phunks/for-the-pham/phunkbot/features.md) in `src/app.module.ts` enabled, your Discord bot will gain some super powers.\
Note: indexing (<mark style="color:blue;">sync</mark>) can take up to 24h, depending on volume and age of your project. \
Here is the list of available commands:

#### Display a list of the owned tokens by a wallet

```typescript
/owned <wallet>
```

#### Display some interesting stats by wallet

```typescript
/userstats <wallet>
```

#### Display collection volume across all markets for given time frame

```typescript
/volume <time frame> 
```

#### Display a graph showing the average price and the volume of Collection over time

```typescript
/graph
```

#### Display the top 20 traders of your Collection for given time frame

```typescript
/traders <time frame>
```

#### Displays indexed info about a given transaction, useful for debugging purposes

```typescript
/transaction <tx>
```

#### Force index of the given transaction within the given block

```typescript
/index <block> <tx>
```

#### Check your Bots current index block number (heartbeat)

```typescript
/status
```

<mark style="background-color:orange;">You will need to set starting block of your collection under /src/config.ts.</mark>

```typescript
  // Enter the block where your contract has been created
  statistic_initial_block: 18035326,
  //
```

</details>

***

## <mark style="color:yellow;">`DAO Commands`</mark>

<details>

<summary>ON DISCORD</summary>

If you have [DAO Module](/knowledge-base/built-by-phunks/for-the-pham/phunkbot/features.md) in `src/app.module.ts` enabled, your Discord bot will gain some amazing super powers. Since we are dealing with community Governance here, commands are split into two categories: <mark style="color:red;">Admin</mark> and <mark style="color:green;">User</mark> commands.&#x20;

### <mark style="color:red;">Admin Commands</mark>

#### Create Poll for users with allowed role (optional) to vote

```typescript
/createpoll <description> <duration> <role> <emojis> <link> <minimumvotes>
```

#### Get detailed Poll results, only visible to Admins

```typescript
/pollresults <poll id>
```

#### Close Poll, forced command

```typescript
/closepoll <poll id>
```

#### Delete Poll, forced command

```typescript
/deletepoll <poll id>
```

***

### <mark style="color:green;">User Commands</mark>

#### List all active Polls

```typescript
/listpolls
```

#### Bind web3 wallet to your Discord account

```typescript
/bindweb3
```

#### Bind twitter account to your Discord account

```typescript
/bindtwitter
```

#### List bounded web3 wallet(s) and twitter account to your Discord account

```typescript
/bounded
```

<mark style="background-color:orange;">To learn more about DAO Module and how it works go to</mark> [GOVERNANCE](/knowledge-base/built-by-phunks/for-the-pham/phunkbot/governance.md)

</details>

***

## <mark style="color:yellow;">`CLI Commands`</mark>

<details>

<summary>REPLAY TRANSACTION</summary>

You might occur situation where you want to repost missed sale or replay specific transaction to monitor bots behaviour and debug. \
This is where CLI extension comes in very handy.

#### To replay transaction with tweeting, run within installation directory

```bash
npm run cli -- --action=tweet --contract=your-contract-here --block=block-number --tx=transaction-hash
```

#### To replay transaction for indexing and debugging, run within installation directory

```bash
npm run cli -- --action=index --contract=your-contract-here --block=block-number --tx=transaction-hash
```

</details>

[^1]: Check [Features](/knowledge-base/built-by-phunks/for-the-pham/phunkbot/features.md) to understand this module.

[^2]: [Check Features to understand this module.](/knowledge-base/built-by-phunks/for-the-pham/phunkbot/features.md)