forked from gumhq/sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5046aee
commit e0ae239
Showing
22 changed files
with
42 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,93 +1,28 @@ | ||
# Gum React SDK | ||
|
||
<p align="center"> | ||
<img alt="npm" src="https://img.shields.io/npm/v/@gumhq/react-sdk?color=%23d45bff"> | ||
<img alt="npm" src="https://img.shields.io/npm/dt/@gumhq/react-sdk?color=%23d45bff"> | ||
<img alt="npm" src="https://img.shields.io/npm/v/@magicblock-labs/gum-react-sdk?color=%23d45bff"> | ||
<img alt="npm" src="https://img.shields.io/npm/dt/@magicblock-labs/gum-react-sdk?color=%23d45bff"> | ||
</p> | ||
|
||
## Installation | ||
|
||
```bash | ||
yarn add @gumhq/react-sdk | ||
yarn add @magicblock-labs/gum-react-sdk | ||
``` | ||
|
||
## Documentation | ||
|
||
For more detailed documentation, please visit the [Magicblock documentation](https://docs.gum.fun/). | ||
|
||
## Usage | ||
|
||
The `useGumContext`, `useCreateProfile`, and `useUploaderContext` hooks provide the necessary utilities to create a new profile. | ||
|
||
```tsx | ||
import { | ||
useCreateProfile, | ||
useGumContext, | ||
useUploaderContext, | ||
} from "@gumhq/react-sdk"; | ||
import { useWallet } from "@solana/wallet-adapter-react"; | ||
import { useState } from "react"; | ||
|
||
export function ProfileCreation() { | ||
const [profileName, setProfileName] = useState(""); | ||
const [profileBio, setProfileBio] = useState(""); | ||
const [profileUsername, setProfileUsername] = useState(""); | ||
const [profileAvatar, setProfileAvatar] = useState(""); | ||
|
||
const wallet = useWallet(); | ||
const { publicKey } = wallet; | ||
const { sdk } = useGumContext(); // access the Gum SDK | ||
const { createProfileWithDomain } = useCreateProfile(sdk); // create a new profile | ||
const { handleUpload } = useUploaderContext(); // upload metadata to Arweave/GenesysGo | ||
|
||
const createProfile = async (event: React.FormEvent<HTMLFormElement>) => { | ||
event.preventDefault(); | ||
|
||
const profileMetadata = { | ||
name: profileName, | ||
bio: profileBio, | ||
avatar: profileAvatar, | ||
}; | ||
|
||
const uploadResponse = await handleUpload(profileMetadata, wallet); | ||
if (!uploadResponse) { | ||
console.error("Error uploading profile metadata"); | ||
return false; | ||
} | ||
|
||
const profileResponse = await createProfileWithDomain( | ||
uploadResponse.url, | ||
profileUsername, | ||
publicKey | ||
); | ||
if (!profileResponse) { | ||
console.error("Error creating profile"); | ||
return false; | ||
} | ||
|
||
console.log("Profile created successfully", profileResponse); | ||
}; | ||
|
||
// Your HTML form and fields would go here | ||
} | ||
``` | ||
|
||
## Gum Quickstart | ||
|
||
The Gum Quickstart is an excellent starting point for developers aiming to leverage Gum in their Next.js applications. This ready-to-use template not only expedites the setup process, but also includes functional examples and components to facilitate the creation of domain profiles, posts, and more. Check out the [Gum Quickstart](https://github.com/gumhq/gum-quickstart) to get started. | ||
For more detailed documentation, please visit the [Magicblock documentation](https://docs.magicblock.gg/Onboarding/Session%20Keys/integrating-sessions-in-your-program). | ||
|
||
## Example App | ||
|
||
Check out the [example app](https://github.com/gumhq/gum-example-app) that uses the Gum SDK to demonstrate its capabilities. The app is a simple React app that showcases the creation of a domain, profile, and posts. | ||
Check out the [example app](https://github.com/solana-developers/solana-game-starter-kits/tree/main/lumberjack) that uses the Gum SDK to demonstrate its capabilities. The app is a simple React app that showcases the use of session keys. | ||
|
||
## Contributing | ||
|
||
We welcome contributions to improve the SDK. Please raise an issue or submit a pull request with any suggestions or bug fixes. | ||
|
||
## License | ||
|
||
The Gum SDK is licensed under the [GNU General Public License v3.0](https://github.com/gumhq/sdk/blob/master/packages/react-sdk/LICENSE). | ||
|
||
## Support | ||
|
||
Join our Discord community at [https://discord.gg/tCswbSK5W2](https://discord.gg/tCswbSK5W2) for any questions or support. | ||
Join our Discord community at [https://discord.com/invite/MBkdC3gxcv](https://discord.com/invite/MBkdC3gxcv) for any questions or support. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters