Helius SDK - v2.2.2
GitHub
npm
Helius Docs
Preparing search index...
auth/types
AuthClient
Interface AuthClient
interface
AuthClient
{
agenticSignup
(
options
:
AgenticSignupOptions
,
)
:
Promise
<
AgenticSignupResult
>
;
checkSolBalance
(
address
:
string
)
:
Promise
<
bigint
>
;
checkUsdcBalance
(
address
:
string
)
:
Promise
<
bigint
>
;
createApiKey
(
jwt
:
string
,
projectId
:
string
,
wallet
:
string
,
)
:
Promise
<
ApiKey
>
;
createProject
(
jwt
:
string
)
:
Promise
<
Project
>
;
executeCheckout
(
secretKey
:
Uint8Array
,
jwt
:
string
,
request
:
CheckoutRequest
,
)
:
Promise
<
CheckoutResult
>
;
executeRenewal
(
secretKey
:
Uint8Array
,
jwt
:
string
,
paymentIntentId
:
string
,
)
:
Promise
<
CheckoutResult
>
;
executeUpgrade
(
secretKey
:
Uint8Array
,
jwt
:
string
,
plan
:
string
,
period
:
"monthly"
|
"yearly"
,
projectId
:
string
,
couponCode
?:
string
,
)
:
Promise
<
CheckoutResult
>
;
generateKeypair
()
:
Promise
<
{
publicKey
:
Uint8Array
;
secretKey
:
Uint8Array
}
,
>
;
getAddress
(
keypair
:
WalletKeypair
)
:
Promise
<
string
>
;
getCheckoutPreview
(
jwt
:
string
,
plan
:
string
,
period
:
"monthly"
|
"yearly"
,
refId
:
string
,
couponCode
?:
string
,
)
:
Promise
<
CheckoutPreviewResponse
>
;
getPaymentIntent
(
jwt
:
string
,
paymentIntentId
:
string
,
)
:
Promise
<
CheckoutInitializeResponse
>
;
getPaymentStatus
(
jwt
:
string
,
paymentIntentId
:
string
,
)
:
Promise
<
CheckoutStatusResponse
>
;
getProject
(
jwt
:
string
,
id
:
string
)
:
Promise
<
ProjectDetails
>
;
initializeCheckout
(
jwt
:
string
,
request
:
CheckoutInitializeRequest
,
)
:
Promise
<
CheckoutInitializeResponse
>
;
listProjects
(
jwt
:
string
)
:
Promise
<
ProjectListItem
[]
>
;
loadKeypair
(
bytes
:
Uint8Array
)
:
WalletKeypair
;
payPaymentIntent
(
secretKey
:
Uint8Array
,
intent
:
CheckoutInitializeResponse
,
)
:
Promise
<
string
>
;
payUSDC
(
secretKey
:
Uint8Array
)
:
Promise
<
string
>
;
payWithMemo
(
secretKey
:
Uint8Array
,
treasury
:
string
,
amount
:
bigint
,
memo
:
string
,
)
:
Promise
<
string
>
;
signAuthMessage
(
secretKey
:
Uint8Array
,
)
:
Promise
<
{
message
:
string
;
signature
:
string
}
>
;
walletSignup
(
msg
:
string
,
sig
:
string
,
address
:
string
,
)
:
Promise
<
SignupResponse
>
;
}
Index
Methods
agentic
Signup
check
Sol
Balance
check
Usdc
Balance
create
Api
Key
create
Project
execute
Checkout
execute
Renewal
execute
Upgrade
generate
Keypair
get
Address
get
Checkout
Preview
get
Payment
Intent
get
Payment
Status
get
Project
initialize
Checkout
list
Projects
load
Keypair
pay
Payment
Intent
pay
USDC
pay
With
Memo
sign
Auth
Message
wallet
Signup
Methods
agentic
Signup
agenticSignup
(
options
:
AgenticSignupOptions
)
:
Promise
<
AgenticSignupResult
>
Parameters
options
:
AgenticSignupOptions
Returns
Promise
<
AgenticSignupResult
>
check
Sol
Balance
checkSolBalance
(
address
:
string
)
:
Promise
<
bigint
>
Parameters
address
:
string
Returns
Promise
<
bigint
>
check
Usdc
Balance
checkUsdcBalance
(
address
:
string
)
:
Promise
<
bigint
>
Parameters
address
:
string
Returns
Promise
<
bigint
>
create
Api
Key
createApiKey
(
jwt
:
string
,
projectId
:
string
,
wallet
:
string
)
:
Promise
<
ApiKey
>
Parameters
jwt
:
string
projectId
:
string
wallet
:
string
Returns
Promise
<
ApiKey
>
create
Project
createProject
(
jwt
:
string
)
:
Promise
<
Project
>
Parameters
jwt
:
string
Returns
Promise
<
Project
>
execute
Checkout
executeCheckout
(
secretKey
:
Uint8Array
,
jwt
:
string
,
request
:
CheckoutRequest
,
)
:
Promise
<
CheckoutResult
>
Parameters
secretKey
:
Uint8Array
jwt
:
string
request
:
CheckoutRequest
Returns
Promise
<
CheckoutResult
>
execute
Renewal
executeRenewal
(
secretKey
:
Uint8Array
,
jwt
:
string
,
paymentIntentId
:
string
,
)
:
Promise
<
CheckoutResult
>
Parameters
secretKey
:
Uint8Array
jwt
:
string
paymentIntentId
:
string
Returns
Promise
<
CheckoutResult
>
execute
Upgrade
executeUpgrade
(
secretKey
:
Uint8Array
,
jwt
:
string
,
plan
:
string
,
period
:
"monthly"
|
"yearly"
,
projectId
:
string
,
couponCode
?:
string
,
)
:
Promise
<
CheckoutResult
>
Parameters
secretKey
:
Uint8Array
jwt
:
string
plan
:
string
period
:
"monthly"
|
"yearly"
projectId
:
string
Optional
couponCode
:
string
Returns
Promise
<
CheckoutResult
>
generate
Keypair
generateKeypair
()
:
Promise
<
{
publicKey
:
Uint8Array
;
secretKey
:
Uint8Array
}
>
Returns
Promise
<
{
publicKey
:
Uint8Array
;
secretKey
:
Uint8Array
}
>
get
Address
getAddress
(
keypair
:
WalletKeypair
)
:
Promise
<
string
>
Parameters
keypair
:
WalletKeypair
Returns
Promise
<
string
>
get
Checkout
Preview
getCheckoutPreview
(
jwt
:
string
,
plan
:
string
,
period
:
"monthly"
|
"yearly"
,
refId
:
string
,
couponCode
?:
string
,
)
:
Promise
<
CheckoutPreviewResponse
>
Parameters
jwt
:
string
plan
:
string
period
:
"monthly"
|
"yearly"
refId
:
string
Optional
couponCode
:
string
Returns
Promise
<
CheckoutPreviewResponse
>
get
Payment
Intent
getPaymentIntent
(
jwt
:
string
,
paymentIntentId
:
string
,
)
:
Promise
<
CheckoutInitializeResponse
>
Parameters
jwt
:
string
paymentIntentId
:
string
Returns
Promise
<
CheckoutInitializeResponse
>
get
Payment
Status
getPaymentStatus
(
jwt
:
string
,
paymentIntentId
:
string
,
)
:
Promise
<
CheckoutStatusResponse
>
Parameters
jwt
:
string
paymentIntentId
:
string
Returns
Promise
<
CheckoutStatusResponse
>
get
Project
getProject
(
jwt
:
string
,
id
:
string
)
:
Promise
<
ProjectDetails
>
Parameters
jwt
:
string
id
:
string
Returns
Promise
<
ProjectDetails
>
initialize
Checkout
initializeCheckout
(
jwt
:
string
,
request
:
CheckoutInitializeRequest
,
)
:
Promise
<
CheckoutInitializeResponse
>
Parameters
jwt
:
string
request
:
CheckoutInitializeRequest
Returns
Promise
<
CheckoutInitializeResponse
>
list
Projects
listProjects
(
jwt
:
string
)
:
Promise
<
ProjectListItem
[]
>
Parameters
jwt
:
string
Returns
Promise
<
ProjectListItem
[]
>
load
Keypair
loadKeypair
(
bytes
:
Uint8Array
)
:
WalletKeypair
Parameters
bytes
:
Uint8Array
Returns
WalletKeypair
pay
Payment
Intent
payPaymentIntent
(
secretKey
:
Uint8Array
,
intent
:
CheckoutInitializeResponse
,
)
:
Promise
<
string
>
Parameters
secretKey
:
Uint8Array
intent
:
CheckoutInitializeResponse
Returns
Promise
<
string
>
pay
USDC
payUSDC
(
secretKey
:
Uint8Array
)
:
Promise
<
string
>
Parameters
secretKey
:
Uint8Array
Returns
Promise
<
string
>
pay
With
Memo
payWithMemo
(
secretKey
:
Uint8Array
,
treasury
:
string
,
amount
:
bigint
,
memo
:
string
,
)
:
Promise
<
string
>
Parameters
secretKey
:
Uint8Array
treasury
:
string
amount
:
bigint
memo
:
string
Returns
Promise
<
string
>
sign
Auth
Message
signAuthMessage
(
secretKey
:
Uint8Array
,
)
:
Promise
<
{
message
:
string
;
signature
:
string
}
>
Parameters
secretKey
:
Uint8Array
Returns
Promise
<
{
message
:
string
;
signature
:
string
}
>
wallet
Signup
walletSignup
(
msg
:
string
,
sig
:
string
,
address
:
string
)
:
Promise
<
SignupResponse
>
Parameters
msg
:
string
sig
:
string
address
:
string
Returns
Promise
<
SignupResponse
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
agentic
Signup
check
Sol
Balance
check
Usdc
Balance
create
Api
Key
create
Project
execute
Checkout
execute
Renewal
execute
Upgrade
generate
Keypair
get
Address
get
Checkout
Preview
get
Payment
Intent
get
Payment
Status
get
Project
initialize
Checkout
list
Projects
load
Keypair
pay
Payment
Intent
pay
USDC
pay
With
Memo
sign
Auth
Message
wallet
Signup
GitHub
npm
Helius Docs
Helius SDK - v2.2.2
Loading...