Skip to content

Commit 1c8868f

Browse files
authored
Update Readme.md
1 parent d59f292 commit 1c8868f

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

packages/plugin-nft-generation/Readme.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
### NFT Collection Generation Plugin
2-
A plugin for handling NFT collection generation, NFT creation, anNFT Collection Generation Plugin
2+
33
A plugin for handling NFT collection generation, NFT creation, and verification on the Solana blockchain.
44

55
## Handlers
6+
67
### createCollection
78
The createCollection handler generates an NFT collection logo, uploads it to AWS S3, and creates a Solana blockchain collection.
89

@@ -18,14 +19,17 @@ const result = await createCollection({
1819

1920
console.log("Collection created:", result);
2021
```
22+
2123
#### Features
24+
2225
Image Generation: Automatically generates a collection logo based on the provided name and theme.
2326
AWS S3 Integration: Uploads the generated logo and metadata to AWS S3.
2427
Solana Blockchain: Creates a collection with the generated logo and metadata on the Solana blockchain.
2528
### createNFT
2629
The createNFT handler generates individual NFTs for a collection. It includes metadata creation and uploads the NFT information to AWS S3.
2730

2831
#### Usage
32+
2933
```typescript
3034
import { createNFT } from "./handlers/createNFT.ts";
3135

@@ -42,9 +46,11 @@ console.log("NFT created:", nftResult);
4246
```
4347

4448
### verifyNFT
49+
4550
The verifyNFT handler verifies an NFT against its collection using the Solana blockchain.
4651

4752
#### Usage
53+
4854
```typescript
4955
import { verifyNFT } from "./handlers/verifyNFT.ts";
5056

@@ -59,6 +65,7 @@ console.log("NFT verified:", verificationResult);
5965
---
6066

6167
### Example Workflow
68+
6269
The plugin provides a streamlined process for generating and verifying NFT collections:
6370

6471
```typescript
@@ -115,6 +122,7 @@ SOLANA_ADMIN_PUBLIC_KEY Admin public key for Solana operations
115122
SOLANA_ADMIN_PRIVATE_KEY Admin private key for Solana operations
116123
```
117124
#### Example Prompts
125+
118126
Here are some examples of user prompts to trigger NFT collection generation:
119127
120128
"Generate a collection named MyCollection."
@@ -124,6 +132,7 @@ Here are some examples of user prompts to trigger NFT collection generation:
124132
125133
126134
#### Local Testing with TEE Simulator
135+
127136
To test locally using a Trusted Execution Environment (TEE) simulator, follow these steps:
128137
129138
Pull the simulator Docker image:
@@ -142,13 +151,16 @@ DSTACK_SIMULATOR_ENDPOINT="http://localhost:8090"
142151
```
143152

144153
#### Dependencies
154+
145155
This plugin relies on the following services and libraries:
146156

147-
[@ai16z/plugin-node]
148-
[@ai16z/eliza]
149-
[@ai16z/plugin-image-generation]
157+
[@elizaos/plugin-node]
158+
[@elizaos/eliza]
159+
[@elizaos/plugin-image-generation]
150160
[@solana/web3.js]
161+
151162
### Action Configuration
163+
152164
#### GENERATE_COLLECTION
153165
The action for generating NFT collections is configured with the following parameters:
154166

0 commit comments

Comments
 (0)