Types

AccountType

type AccountType = {
    provider: string,
    providerSupports: string[]|undefined,
    cspr_name: string | null,
    public_key: string | null,
    connected_at: Number,
    token: string | null,
    custom?: any,
    balance?: string,
    liquid_balance?: string;
    logo?: string;
}

Property	Description
provider	The provider to which the account belongs to.
providerSupports	An array of supported capabilities in the connected wallet. Possible values: "sign-deploy", "sign-transactionv1", "sign-message".
cspr_name	CSPR.name name
public_key	The public key.
connected_at	Timestamp for the initial connection of the account
token	n/a (for future use)
custom	Custom data. Depends on the provider.
balance	Total balance of the account in CSPR motes (includes liquid +staked balance)
liquid_balance	Liquid balance of the account in CSPR motes (includes liquid +staked balance)
logo	A URL to the account avatar or logo.

CsprClickInitOptions

type CsprClickInitOptions = {
    appName: string,
    appId: string,
    contentMode: 'iframe' | 'popup',
    casperNode?: string,
    chainName?: string,
    providers: Array<string>,
}

Property	Description
appName	The name of your app as it will be shown in the pop-up windows.
appId	An application identifier. Read more about it here.
contentMode	Defines whether the sign in interface is shown within an iframe in your application or in external pop-up windows.
casperNode	The RPC endpoint CSPR.click uses to get information from the Casper network and to send deploys.
chainName	Use casper or casper-test to interact with Casper Mainnet or Casper Testnet, respectively.
providers	The list of providers (wallets) you want to allow in your application

The wallets you can add to the providers array are:

• casper-wallet

• ledger

• metamask-snap

ProviderInfo

type ProviderInfo = {
    key: string,
    name: string,
    version: string,
    supports: Array<string>,
}

Property	Description
key	Internal name of the provider (wallet).
name	Friendly/Huma readable name of the provider.
version	Version of the provider. Only available for some wallets, when they're installed and/or connected.
supports	Array of keys of the features supported. The values returned may depend on the connected version of the provider. Currently, the possible supported features are: sign-deploy, sign-transactionv1, and sign-message.

SendResult

type SendResult = {
    cancelled: boolean,
    deployHash: string | null,
    transactionHash: string | null,
    error: string | null,
    errorData: object | null,
    status: string | null;
    csprCloudTransaction: any;
}

Property	Description
cancelled	true when the user has declined the signature of the transaction. false otherwise
deployHash	The hash of the deploy signed and sent to the Casper network. null when the deploy signature has been cancelled or there was an error sending it to the network
error	null if the deploy has been successfully signed and sent to the network. It contains an error message when the network rejects the deploy.
errorData	extra information on the error. It's usually a json object.
status	Indicates the status of the transaction sent. This property is helpful when used in combination with the `waitProcessing` in the `send()` method. Possible values: "sent", "processed", "created", "cancelled", "error", "timeout".
csprCloudTransaction	Raw json object returned by CSPR.cloud streaming API for a processed transaction. Check CSPR.cloud docs for detailed info on the contents.

SignResult

type SignResult = {
    cancelled: boolean,
    signatureHex: string | null,
    signature: Uint8Array | null,
    deploy: object | null,
    transaction: object | null,
    error: string | null,
}

Property	Description
cancelled	true when the user has declined the signature of the transaction. false otherwise
signatureHex	An hexadecimal string with the crytpographic signature of the deploy.
signature	A byte array with the cryptographic signature of the deploy.
deploy	A json object containing the deploy with the user approval entry (i.e., the new signature).
error	null if the deploy has been successfully signed. It contains an error message otherwise.