Preparing search index...
The search index is not available
Carrot Protocol Documentation
Carrot Protocol Documentation
@carrot-protocol/http-client
Client
Class Client
Index
Constructors
constructor
Properties
base
Url
provider
Methods
check
Wallet
claim
Referral
Code
get
Historical
Vault
Apy
get
Historical
Vault
Nav
get
Referral
Codes
get
User
get
User
Performance
get
Vault
get
Vault
Performance
index
issue
redeem
Constructors
constructor
new
Client
(
baseUrl
:
string
,
provider
?:
AnchorProvider
)
:
Client
Parameters
baseUrl
:
string
Optional
provider
:
AnchorProvider
Returns
Client
Properties
Readonly
base
Url
baseUrl
:
string
Readonly
provider
provider
:
undefined
|
AnchorProvider
Methods
check
Wallet
checkWallet
(
wallet
:
PublicKey
)
:
Promise
<
CheckWalletResponse
>
Parameters
wallet
:
PublicKey
Returns
Promise
<
CheckWalletResponse
>
claim
Referral
Code
claimReferralCode
(
wallet
:
PublicKey
,
code
:
string
,
)
:
Promise
<
ClaimReferralCodeResponse
>
Parameters
wallet
:
PublicKey
code
:
string
Returns
Promise
<
ClaimReferralCodeResponse
>
get
Historical
Vault
Apy
getHistoricalVaultApy
(
vault
:
PublicKey
,
interval
:
"HOUR"
|
"DAY"
|
"WEEK"
,
)
:
Promise
<
HistoricalVaultApyResponse
>
Parameters
vault
:
PublicKey
interval
:
"HOUR"
|
"DAY"
|
"WEEK"
Returns
Promise
<
HistoricalVaultApyResponse
>
get
Historical
Vault
Nav
getHistoricalVaultNav
(
vault
:
PublicKey
,
interval
:
"HOUR"
|
"DAY"
|
"WEEK"
,
)
:
Promise
<
HistoricalVaultNavResponse
>
Parameters
vault
:
PublicKey
interval
:
"HOUR"
|
"DAY"
|
"WEEK"
Returns
Promise
<
HistoricalVaultNavResponse
>
get
Referral
Codes
getReferralCodes
(
wallet
:
PublicKey
)
:
Promise
<
GetReferralCodesResponse
>
Parameters
wallet
:
PublicKey
Returns
Promise
<
GetReferralCodesResponse
>
get
User
getUser
(
vault
:
PublicKey
)
:
Promise
<
UserResponse
>
Parameters
vault
:
PublicKey
Returns
Promise
<
UserResponse
>
get
User
Performance
getUserPerformance
(
vault
:
PublicKey
,
wallets
:
PublicKey
[]
,
)
:
Promise
<
UserPerformanceResponse
>
Parameters
vault
:
PublicKey
wallets
:
PublicKey
[]
Returns
Promise
<
UserPerformanceResponse
>
get
Vault
getVault
(
vault
:
PublicKey
,
useCache
:
boolean
)
:
Promise
<
Common
.
Vault
>
Parameters
vault
:
PublicKey
useCache
:
boolean
Returns
Promise
<
Common
.
Vault
>
get
Vault
Performance
getVaultPerformance
(
vault
:
PublicKey
,
useCache
:
boolean
,
)
:
Promise
<
Common
.
VaultPerformance
>
Parameters
vault
:
PublicKey
useCache
:
boolean
Returns
Promise
<
Common
.
VaultPerformance
>
index
index
()
:
Promise
<
void
>
Returns
Promise
<
void
>
issue
issue
(
vault
:
PublicKey
,
assetMint
:
PublicKey
,
amount
:
BN
)
:
Promise
<
string
>
Parameters
vault
:
PublicKey
assetMint
:
PublicKey
amount
:
BN
Returns
Promise
<
string
>
redeem
redeem
(
vault
:
PublicKey
,
assetMint
:
PublicKey
,
amount
:
BN
)
:
Promise
<
string
>
Parameters
vault
:
PublicKey
assetMint
:
PublicKey
amount
:
BN
Returns
Promise
<
string
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
base
Url
provider
Methods
check
Wallet
claim
Referral
Code
get
Historical
Vault
Apy
get
Historical
Vault
Nav
get
Referral
Codes
get
User
get
User
Performance
get
Vault
get
Vault
Performance
index
issue
redeem
Carrot Protocol Documentation
Loading...