Skip to content

Commit

Permalink
Merge branch 'main' into chore/bump-v1
Browse files Browse the repository at this point in the history
  • Loading branch information
aspnxdd committed Jan 25, 2023
2 parents e3cc875 + 1ca8222 commit 56313dc
Show file tree
Hide file tree
Showing 3 changed files with 169 additions and 394 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@

<h1 align="center">Candymachine Client SDK</h1>
<p align="center">A full-featured Solana Metaplex Candymachine client-side library in Typescript</p>
<p align="center">A full-featured Solana Metaplex Candy Machine V2 client-side library in Typescript</p>

> **Disclaimer:** The SDK is currently a pre-alpha version
## About

The Candymachine Client SDK offers all functionalities of the former Metaplex Candy Machine CLI but on a standalone pure Typescript client-side library that can run on any browser.

> **IMPORTANT:** This SDK is only compatible with the Candy Machine V2. The Candy Machine V1 or V3 are not compatible.
### Features

- Create a Candy Machine V2 with multiple and configurable settings:
- Captcha enabled/disabled.
- Mutability on the NFTs.
- Price, number of NFTs.
- Authority.
- NFTs hosted on Arweave.
- Time and date to start the minting.
- Update any Candy Machine V2 in which you are the authority and have the cache file.
- Explore any Candy Machine V2, view the minted NFTs, remaining NFTs to mint...
- Mint a NFT from the Candy Machine V2.
- Available on Solana's Mainnet and Devnet networks.
- Fully compatible with React and NextJS.
- Create a Candy Machine V2 with multiple and configurable settings:
- Captcha enabled/disabled.
- Mutability on the NFTs.
- Price, number of NFTs.
- Authority.
- NFTs hosted on Arweave.
- Time and date to start the minting.
- Update any Candy Machine V2 in which you are the authority and have the cache file.
- Explore any Candy Machine V2, view the minted NFTs, remaining NFTs to mint...
- Mint a NFT from the Candy Machine V2.
- Available on Solana's Mainnet and Devnet networks.
- Fully compatible with React and NextJS.

### Built with

- Typescript
- Metaplex
- Anchor from Serum
- Solana web3.js
- Typescript
- Metaplex
- Anchor from Serum
- Solana web3.js

<br/>

Expand All @@ -44,7 +45,7 @@ $ pnpm add @boxfish-studio/candymachine-client-sdk

## How to use

### Upload your first Candy Machine
### Upload your first Candy Machine v2

1. Import `uploadV2, loadCandyProgramV2, StorageType, verifyAssets` functions and enums:

Expand Down Expand Up @@ -151,4 +152,3 @@ This SDK has been built thanks to Metaplex's Candy Machine CLI.
[Apache 2.0](./LICENSE) &copy; [Boxfish Studio]

[Boxfish Studio]: https://boxfish.studio

16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,24 @@
"author": "Boxfish Studio <info@boxfish.studio>",
"license": "Apache-2.0",
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^5.48.2",
"@typescript-eslint/parser": "^5.48.2",
"@typescript-eslint/eslint-plugin": "^5.49.0",
"@typescript-eslint/parser": "^5.49.0",
"eslint": "^8.32.0",
"tsup": "^6.5.0",
"typescript": "^4.7.4"
"typescript": "^4.9.4",
"tsup": "^6.5.0"
},
"dependencies": {
"@babel/core": "^7.20.12",
"@babel/eslint-parser": "^7.19.1",
"@metaplex/arweave-cost": "^1.0.4",
"@project-serum/anchor": "^0.25.0",
"@solana/spl-token": "^0.2.0",
"@solana/web3.js": "^1.50.1",
"@project-serum/anchor": "^0.26.0",
"@solana/spl-token": "^0.3.7",
"@solana/web3.js": "^1.73.0",
"@supercharge/promise-pool": "^2.3.2",
"husky": "^8.0.3",
"js-file-download": "^0.4.12",
"lint-staged": "^13.1.0",
"prettier": "^2.8.2"
"prettier": "^2.8.3"
},
"lint-staged": {
"*.{js,ts}": [
Expand Down
Loading

0 comments on commit 56313dc

Please sign in to comment.