Artemis SDK is a React library built with TypeScript, designed to simplify the integration of NEAR Blockchain functionality into React applications. It abstracts the usage of the NEAR-API-JS library and provides easy access to public APIs from the NEAR block explorer.
npm install artemis-sdkor
yarn add artemis-sdkArtemis-SDK makes it straightforward to interact with the NEAR Blockchain in your React applications. Here's a quick example using Next.js:
"use client"
import { useNearWallet } from "artemis-sdk"
export default function Home() {
const { isLoading, wallet } = useNearWallet()
if (isLoading) {
return (
<div>
<span>LOADING...</span>
</div>
)
}
return (
<div>
<pre>{JSON.stringify(wallet, null, 2)}</pre>
</div>
)
}- Abstracts NEAR-API-JS for simplified integration.
- Provides easy access to public APIs from the NEAR block explorer.
- Written in TypeScript for enhanced development experience.
The useNearWallet hook initializes a connection to the NEAR blockchain and provides access to the connected wallet instance.
const { isLoading, wallet } = useNearWallet()wallet: An instance of the NEAR WalletConnection.isLoading: A boolean indicating whether the wallet is still loading.
The useSignin hook returns a function that trigger a sign in event and redirect you to near wallet platform.
const { onSignin } = useSignin({
contractId,
failureUrl,
methodNames,
successUrl,
})onSignin: A function that trigger a sign in event and redirect you to near wallet platform.contractId: The Near Contract ID you wanna interact with.failureUrl: The URL user will be redirect if the sign in goes wrong. (optional)successUrl: The URL user will be redirect if the sign in works correctly. (optional)methodNames: The methods from the Near Contract. (optional - By default you will get access to all methods)
The useSignout hook returns a function that sign out your connected wallet.
const { onSignout } = useSignout()onSignout: A function that sign out your connected wallet.
The useSend hook returns a function that send near from your connected wallet to another specified near account.
The useInventory hook returns all FTs and NFTs data from a near wallet.
const { inventory, isLoading } = useInventory("accountId.testnet")inventory: All wallet FTs and NFTs data.isLoading: A boolean indicating whether the inventory is still loading.
The useAccount hook returns all data from a near blockchain account.
const { account, isLoading } = useAccount("accountId.testnet")account: An account data object.isLoading: A boolean indicating whether the account is still loading.
The parseYocto converts NEAR Token amount to YoctoNEAR and return its value.
const yoctoNearAmount = parseYocto("1")yoctoNearAmount: Amount in YoctoNEAR.
The parseNear converts YoctoNEAR Token amount to NEAR and return its value.
const nearAmount = parseNear("1000000000000000000000000")nearAmount: Amount in NEAR.
We welcome contributions! Feel free to open issues or pull requests. For major changes, please open an issue first to discuss what you would like to change on Github.