Generate Yield

Staking is available under private access. Contact us if you need access

Prerequisites

Ensure you have a wallet created.
API Key: Ensure you have an API key with the scopes: wallets:transactions.create.

Listing yields

List available yield opportunities for a wallet.

React
Node.js
React Native

import { useWallet } from '@crossmint/client-sdk-react-ui';

const { wallet } = useWallet();

const yields = await wallet.experimental_yields(tokens);

Parameters

string[]

The tokens to generate yield for.

Returns

Yield[]

The yields.

const wallet = await crossmintWallets.getWallet(walletLocator);

const yields = await wallet.experimental_yields(tokens);

Parameters

string[]

The tokens to generate yield for.

Returns

Yield[]

The yields.

import { useWallet } from '@crossmint/client-sdk-react-native-ui';

const { wallet } = useWallet();

const yields = await wallet.experimental_yields(tokens);

Parameters

string[]

The tokens to generate yield for.

Staking

Stake to earn yield.

React
Node.js
React Native

import { useWallet } from '@crossmint/client-sdk-react-ui';

const { wallet } = useWallet();

const { hash, explorerLink } = await wallet.experimental_stake(tokenLocator, amount);

Parameters

string

The token locator to stake.

string

The amount to stake.

Returns

string

The hash of the transaction.

string

The explorer link of the transaction.

const wallet = await crossmintWallets.getWallet(walletLocator);

const { hash, explorerLink } = await wallet.experimental_stake(tokenLocator, amount);

Parameters

string

The token locator to stake.

string

The amount to stake.

Returns

string

The hash of the transaction.

string

The explorer link of the transaction.

import { useWallet } from '@crossmint/client-sdk-react-native-ui';

const { wallet } = useWallet();

const { hash, explorerLink } = await wallet.experimental_stake(tokenLocator, amount);

Parameters

string

The token locator to stake.

string

The amount to stake.

Returns

string

The hash of the transaction.

string

The explorer link of the transaction.

Unstaking

Unstake from the yield.

React
Node.js
React Native

import { useWallet } from '@crossmint/client-sdk-react-ui';

const { wallet } = useWallet();

const { hash, explorerLink } = await wallet.experimental_unstake(tokenLocator, amount);

Parameters

string

The token locator to unstake.

string

The amount to unstake.

Returns

string

The hash of the transaction.

string

The explorer link of the transaction.

const wallet = await crossmintWallets.getWallet(walletLocator);

const { hash, explorerLink } = await wallet.experimental_unstake(tokenLocator, amount);

import { useWallet } from '@crossmint/client-sdk-react-native-ui';

const { wallet } = useWallet();

const { hash, explorerLink } = await wallet.experimental_unstake(tokenLocator, amount);

Parameters

string

The token locator to unstake.

string

The amount to unstake.

Returns

string

The hash of the transaction.

string

The explorer link of the transaction.

Introduction

Wallets

Authentication

Tokenization (Minting)

Verifiable Credentials

Checkout

Prerequisites

Listing yields

Parameters

Returns

Parameters

Returns

Parameters

Staking

Parameters

Returns

Parameters

Returns

Parameters

Returns

Unstaking

Parameters

Returns

Parameters

Returns

​Prerequisites

​Listing yields

​Parameters

​Returns

​Parameters

​Returns

​Parameters

​Staking

​Parameters

​Returns

​Parameters

​Returns

​Parameters

​Returns

​Unstaking

​Parameters

​Returns

​Parameters

​Returns

Prerequisites

Listing yields

Parameters

Returns

Parameters

Returns

Parameters

Staking

Parameters

Returns

Parameters

Returns

Parameters

Returns

Unstaking

Parameters

Returns

Parameters

Returns