Skip to main content
Version: Next

Interface: EnvVars

Important context that is used throughout the SDK. This is generated when initKeypom is called and can be retrieved by calling useKeypom. All parameters will start off as undefined until the Keypom SDK is initialized.

Properties​

attachedGas​

Optional attachedGas: string

The amount of Gas that will be attached to the claim and create_account_and_claim functions for claiming linkdrops (100 TGas).

Defined in​

lib/types/general.ts:77

connection​

Optional connection: Connection

The connection instance that is part of the NEAR object

Defined in​

lib/types/general.ts:59

contractAccount​

Optional contractAccount: Account

The NEAR Account object for the Keypom contract being used. This lets you know the account ID for the contract and can be used to sign transactions for claiming linkdrops.

Defined in​

lib/types/general.ts:69

contractId​

Optional contractId: string

The account ID where the Keypom contract is deployed to.

Defined in​

lib/types/general.ts:79

error​

Optional error: string

Defined in​

lib/types/general.ts:83

execute​

Optional execute: any

Defined in​

lib/types/general.ts:87

fundingAccount​

Optional fundingAccount: Account

The NEAR Account object for the Funder

Defined in​

lib/types/general.ts:65

fundingAccountDetails​

Optional fundingAccountDetails: Funder

The details for the funder such as any rootEntropy or their secretKey etc.

Defined in​

lib/types/general.ts:67

gas​

Optional gas: string

The default amount of Gas that will be attached to transactions (200 TGas).

Defined in​

lib/types/general.ts:73

gas300​

Optional gas300: string

The max amount of Gas that will be attached to transactions (300 TGas).

Defined in​

lib/types/general.ts:75

getAccount​

Optional getAccount: any

Defined in​

lib/types/general.ts:85

keyStore​

Optional keyStore: KeyStore

Which type of KeyStore is used when locating keys and signing transactions throughout the SDK (In Memory, Unencrypted FileStore etc.)

Defined in​

lib/types/general.ts:61

near​

Optional near: Near

The specific NEAR object that contains important information such as the KeyStore and connection. This is used to interact with the chain and can either be manually passed in or will be automatically created during initKeypom

Defined in​

lib/types/general.ts:57

networkId​

Optional networkId: string

What network is the SDK using (testnet or mainnet)

Defined in​

lib/types/general.ts:63

receiverId​

Optional receiverId: string

Defined in​

lib/types/general.ts:81

supportedKeypomContracts​

Optional supportedKeypomContracts: Object

Object containing the supported Keypom contracts for both mainnet and testnet

Type declaration​

NameType
mainnet{}
testnet{}

Defined in​

lib/types/general.ts:89

viewAccount​

Optional viewAccount: any

Defined in​

lib/types/general.ts:71

viewCall​

Optional viewCall: any

Function that allows you to invoke a view method. This takes in a receiverId, methodName, and args.

Defined in​

lib/types/general.ts:91