Function bytes
- bytes(s): Uint8Array
Convert a string to Uint8Array, each character must have a char code between 0-255.
+bytes | near-sdk-js - v2.0.0 \ No newline at end of file +Generated using TypeDoc
Generated using TypeDoc
Function concat
- concat(array1, array2): Uint8Array
Concat two Uint8Array
+concat | near-sdk-js - v2.0.0 \ No newline at end of file +Generated using TypeDoc
Generated using TypeDoc
Function decode
- decode(a): string
Decode the Uint8Array to string in UTF-8 encoding
+decode | near-sdk-js - v2.0.0 \ No newline at end of file +Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function encode
- encode(s): Uint8Array
Encode the string to Uint8Array with UTF-8 encoding
+encode | near-sdk-js - v2.0.0 \ No newline at end of file +Generated using TypeDoc
Generated using TypeDoc
Function getValueWithOptions
- get
Value With Options<DataType>(subDatatype, value, options?): DataType | null Type Parameters
DataType
Parameters
subDatatype: unknown
value: Uint8Array
options: Omit<GetOptions<DataType>, "serializer"> = ...
Returns DataType | null
Generated using TypeDoc
Function getValueWithOptions
- get
Value With Options<DataType>(subDatatype, value, options?): DataType | null Type Parameters
DataType
Parameters
subDatatype: unknown
value: Uint8Array
options: Omit<GetOptions<DataType>, "serializer"> = ...
Returns DataType | null
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function serializeValueWithOptions
- serialize
Value With Options<DataType>(value, __namedParameters?): Uint8Array Type Parameters
DataType
Parameters
value: DataType
__namedParameters: Pick<GetOptions<DataType>, "serializer"> = ...
Returns Uint8Array
Generated using TypeDoc
Function serializeValueWithOptions
- serialize
Value With Options<DataType>(value, __namedParameters?): Uint8Array Type Parameters
DataType
Parameters
value: DataType
__namedParameters: Pick<GetOptions<DataType>, "serializer"> = ...
Returns Uint8Array
Generated using TypeDoc
Function str
- str(a): string
Convert a Uint8Array to string, each uint8 to the single character of that char code
+str | near-sdk-js - v2.0.0 \ No newline at end of file +Generated using TypeDoc
Generated using TypeDoc
Function validateAccountId
- validate
Account Id(accountId): boolean Validates the Account ID according to the NEAR protocol +
validateAccountId | near-sdk-js - v2.0.0 Function validateAccountId
- validate
Account Id(accountId): boolean Validates the Account ID according to the NEAR protocol Account ID rules.
Parameters
accountId: string
The Account ID string you want to validate.
-
Returns boolean
\ No newline at end of file +Generated using TypeDoc
- validate
Returns boolean
Generated using TypeDoc
near-sdk-js - v1.0.0
NEAR JavaScript SDK
+
near-sdk-js - v2.0.0
NEAR JavaScript SDK
License
This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE and LICENSE-APACHE for details.
-Generated using TypeDoc
Generated using TypeDoc
Interface GetOptions<DataType>
Options for retrieving and storing data in the SDK collections.
-interface GetOptions {
    defaultValue?: DataType;
    deserializer?(valueToDeserialize): unknown;
    reconstructor?(value): DataType;
    serializer?(valueToSerialize): Uint8Array;
}
    defaultValue?: DataType;
    deserializer?(valueToDeserialize): unknown;
    reconstructor?(value): DataType;
    serializer?(valueToSerialize): Uint8Array;
}
Type Parameters
DataType
Index
Properties
defaultGetOptions | near-sdk-js - v2.0.0
Interface GetOptions<DataType>
Options for retrieving and storing data in the SDK collections.
+interface GetOptions {
    defaultValue?: DataType;
    deserializer?(valueToDeserialize): unknown;
    reconstructor?(value): DataType;
    serializer?(valueToSerialize): Uint8Array;
}
    defaultValue?: DataType;
    deserializer?(valueToDeserialize): unknown;
    reconstructor?(value): DataType;
    serializer?(valueToSerialize): Uint8Array;
}
Type Parameters
DataType
Index
Properties
Methods
Properties
Optional default
default
A default value to return if the original value is not present or null.
-Methods
Optional deserializer
Methods
Optional deserializer
Optional reconstructor
Returns unknown
Optional reconstructor
- reconstructor(value): DataType
A constructor function to call after deserializing a value. Tipically this is a constructor of the class you are storing.
Parameters
value: unknown
The value returned from deserialization - either the provided
-deserializeror default deserialization function.
Returns DataType
Optional serializer
Returns DataType
Optional serializer
Generated using TypeDoc
Returns Uint8Array
Generated using TypeDoc
Interface Env
interface Env {
    latin1_string_to_uint8array(s): Uint8Array;
    uint8array_to_latin1_string(a): string;
    uint8array_to_utf8_string(a): string;
    utf8_string_to_uint8array(s): Uint8Array;
}
    latin1_string_to_uint8array(s): Uint8Array;
    uint8array_to_latin1_string(a): string;
    uint8array_to_utf8_string(a): string;
    utf8_string_to_uint8array(s): Uint8Array;
}
Index
Methods
latin1_Env | near-sdk-js - v2.0.0 latin1_
uint8array_
uint8array_
utf8_
Interface Env
interface Env {
    latin1_string_to_uint8array(s): Uint8Array;
    uint8array_to_latin1_string(a): string;
    uint8array_to_utf8_string(a): string;
    utf8_string_to_uint8array(s): Uint8Array;
}
    latin1_string_to_uint8array(s): Uint8Array;
    uint8array_to_latin1_string(a): string;
    uint8array_to_utf8_string(a): string;
    utf8_string_to_uint8array(s): Uint8Array;
}
Methods
latin1_
uint8array_
uint8array_
utf8_
Generated using TypeDoc
Methods
latin1_
uint8array_
uint8array_
utf8_
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Module api
Index
Functions
accountapi | near-sdk-js - v2.0.0
Module api
Index
Functions
Generated using TypeDoc
Generated using TypeDoc
Module cli/abi
Index
Functions
Generated using TypeDoc
Module cli/abi
Index
Functions
Generated using TypeDoc
Module cli/build-tools/include-bytes
Index
Functions
default
-
Generated using TypeDoc
Module cli/build-tools/include-bytes
Index
Functions
default
+
Generated using TypeDoc
Module cli/build-tools/near-bindgen-exporter
Index
Functions
default
-
Generated using TypeDoc
Module cli/build-tools/near-bindgen-exporter
Index
Functions
default
+
Generated using TypeDoc
Generated using TypeDoc
Module cli/post-install
Generated using TypeDoc
Module cli/post-install
Generated using TypeDoc
Generated using TypeDoc
Module collections
Index
References
Lookupcollections | near-sdk-js - v2.0.0
Lookup
Re-exports LookupMapLookup
Re-exports LookupSetSub
Re-exports SubTypeUnordered
Re-exports UnorderedMapUnordered
Re-exports UnorderedSetVector
Re-exports VectorIterator
Module collections
Index
References
References
Lookup
Re-exports LookupMapLookup
Re-exports LookupSetSub
Re-exports SubTypeUnordered
Re-exports UnorderedMapUnordered
Re-exports UnorderedSetVector
Re-exports VectorVector
Re-exports VectorIteratorGenerated using TypeDoc
References
Lookup
Re-exports LookupMapLookup
Re-exports LookupSetSub
Re-exports SubTypeUnordered
Re-exports UnorderedMapUnordered
Re-exports UnorderedSetVector
Re-exports VectorVector
Re-exports VectorIteratorGenerated using TypeDoc
Module collections/lookup-map
Index
Classes
Generated using TypeDoc
Module collections/lookup-map
Index
Classes
Generated using TypeDoc
Module collections/lookup-set
Index
Classes
Generated using TypeDoc
Module collections/lookup-set
Index
Classes
Generated using TypeDoc
Module collections/subtype
Index
Classes
Sub
Generated using TypeDoc
Module collections/subtype
Index
Classes
Sub
Generated using TypeDoc
Module collections/unordered-map
Index
Classes
Generated using TypeDoc
Module collections/unordered-map
Index
Classes
Generated using TypeDoc
Module collections/unordered-set
Index
Classes
Generated using TypeDoc
Module collections/unordered-set
Index
Classes
Generated using TypeDoc
Generated using TypeDoc
Module index
Index
References
Accountindex | near-sdk-js - v2.0.0
Account
Re-exports AccountIdAdd
Re-exports AddAccessKeyAdd
Re-exports AddFullAccessKeyBase58
Re-exports Base58ErrorBlock
Re-exports BlockHeightCreate
Re-exports CreateAccountCurve
Re-exports CurveTypeDelete
Re-exports DeleteAccountDelete
Re-exports DeleteKeyDeploy
Re-exports DeployContractERR_
Re-exports ERR_INCONSISTENT_STATEERR_
Re-exports ERR_INDEX_OUT_OF_BOUNDSEpoch
Re-exports EpochHeightFunction
Re-exports FunctionCallFunction
Re-exports FunctionCallRawFunction
Re-exports FunctionCallWeightFunction
Re-exports FunctionCallWeightRawGas
Re-exports GasWeightInto
Re-exports IntoStorageKeyInvalid
Re-exports InvalidLengthErrorIterator
Re-exports IteratorIndexLookup
Re-exports LookupMapLookup
Re-exports LookupSetNear
Re-exports NearAmountNear
Re-exports NearBindgenNear
Re-exports NearPromiseONE_
Re-exports ONE_NEARONE_
Re-exports ONE_TERA_GASONE_
Re-exports ONE_YOCTOParse
Re-exports ParsePublicKeyErrorPromise
Re-exports PromiseActionPromise
Re-exports PromiseErrorPromise
Re-exports PromiseIndexPromise
Re-exports PromiseJointPromise
Re-exports PromiseOrValuePromise
Re-exports PromiseResultPublic
Re-exports PublicKeyReceipt
Re-exports ReceiptIndexStorage
Re-exports StorageUsageSub
Re-exports SubTypeText
Re-exports TextDecoderText
Re-exports TextEncoderUnknown
Re-exports UnknownCurveUnordered
Re-exports UnorderedMapUnordered
Re-exports UnorderedSetVector
Re-exports VectorIteratorcurve
Re-exports curveTypeFromStrdecode
Re-exports decodeObj2classget
Re-exports getValueWithOptionsserialize
Re-exports serializeValueWithOptionsvalidate
Re-exports validateAccountId
Module index
Index
References
Functions
References
Account
Re-exports AccountIdAdd
Re-exports AddAccessKeyAdd
Re-exports AddFullAccessKeyBalance
Re-exports BalanceBase58
Re-exports Base58ErrorBlock
Re-exports BlockHeightCreate
Re-exports CreateAccountCurve
Re-exports CurveTypeDelete
Re-exports DeleteAccountDelete
Re-exports DeleteKeyDeploy
Re-exports DeployContractERR_
Re-exports ERR_INCONSISTENT_STATEERR_
Re-exports ERR_INDEX_OUT_OF_BOUNDSEnv
Re-exports EnvEpoch
Re-exports EpochHeightFunction
Re-exports FunctionCallFunction
Re-exports FunctionCallRawFunction
Re-exports FunctionCallWeightFunction
Re-exports FunctionCallWeightRawGas
Re-exports GasGas
Re-exports GasWeightInto
Re-exports IntoStorageKeyInvalid
Re-exports InvalidLengthErrorIterator
Re-exports IteratorIndexLookup
Re-exports LookupMapLookup
Re-exports LookupSetMutable
Re-exports MutableNear
Re-exports NearAmountNear
Re-exports NearBindgenNear
Re-exports NearPromiseNonce
Re-exports NonceONE_
Re-exports ONE_NEARONE_
Re-exports ONE_TERA_GASONE_
Re-exports ONE_YOCTOParse
Re-exports ParsePublicKeyErrorPromise
Re-exports PromiseActionPromise
Re-exports PromiseErrorPromise
Re-exports PromiseIndexPromise
Re-exports PromiseJointPromise
Re-exports PromiseOrValuePromise
Re-exports PromiseResultPublic
Re-exports PublicKeyReceipt
Re-exports ReceiptIndexRegister
Re-exports RegisterStake
Re-exports StakeStorage
Re-exports StorageUsageSub
Re-exports SubTypeText
Re-exports TextDecoderText
Re-exports TextEncoderTransfer
Re-exports TransferUnknown
Re-exports UnknownCurveUnordered
Re-exports UnorderedMapUnordered
Re-exports UnorderedSetVector
Re-exports VectorVector
Re-exports VectorIteratorassert
Re-exports assertbytes
Re-exports bytescall
Re-exports callconcat
Re-exports concatcurve
Re-exports curveTypeFromStrdecode
Re-exports decodedecode
Re-exports decodeObj2classdeserialize
Re-exports deserializeencode
Re-exports encodeget
Re-exports getValueWithOptionsinitialize
Re-exports initializemiddleware
Re-exports middlewaremigrate
Re-exports migratenear
Renames and re-exports apiserialize
Re-exports serializeserialize
Re-exports serializeValueWithOptionsstr
Re-exports strvalidate
Re-exports validateAccountIdview
Re-exports viewGenerated using TypeDoc
References
Account
Re-exports AccountIdAdd
Re-exports AddAccessKeyAdd
Re-exports AddFullAccessKeyBalance
Re-exports BalanceBase58
Re-exports Base58ErrorBlock
Re-exports BlockHeightCreate
Re-exports CreateAccountCurve
Re-exports CurveTypeDelete
Re-exports DeleteAccountDelete
Re-exports DeleteKeyDeploy
Re-exports DeployContractERR_
Re-exports ERR_INCONSISTENT_STATEERR_
Re-exports ERR_INDEX_OUT_OF_BOUNDSEnv
Re-exports EnvEpoch
Re-exports EpochHeightFunction
Re-exports FunctionCallFunction
Re-exports FunctionCallRawFunction
Re-exports FunctionCallWeightFunction
Re-exports FunctionCallWeightRawGas
Re-exports GasGas
Re-exports GasWeightInto
Re-exports IntoStorageKeyInvalid
Re-exports InvalidLengthErrorIterator
Re-exports IteratorIndexLookup
Re-exports LookupMapLookup
Re-exports LookupSetMutable
Re-exports MutableNear
Re-exports NearAmountNear
Re-exports NearBindgenNear
Re-exports NearPromiseNonce
Re-exports NonceONE_
Re-exports ONE_NEARONE_
Re-exports ONE_TERA_GASONE_
Re-exports ONE_YOCTOParse
Re-exports ParsePublicKeyErrorPromise
Re-exports PromiseActionPromise
Re-exports PromiseErrorPromise
Re-exports PromiseIndexPromise
Re-exports PromiseJointPromise
Re-exports PromiseOrValuePromise
Re-exports PromiseResultPublic
Re-exports PublicKeyReceipt
Re-exports ReceiptIndexRegister
Re-exports RegisterStake
Re-exports StakeStorage
Re-exports StorageUsageSub
Re-exports SubTypeText
Re-exports TextDecoderText
Re-exports TextEncoderTransfer
Re-exports TransferUnknown
Re-exports UnknownCurveUnordered
Re-exports UnorderedMapUnordered
Re-exports UnorderedSetVector
Re-exports VectorVector
Re-exports VectorIteratorassert
Re-exports assertbytes
Re-exports bytescall
Re-exports callconcat
Re-exports concatcurve
Re-exports curveTypeFromStrdecode
Re-exports decodedecode
Re-exports decodeObj2classdeserialize
Re-exports deserializeencode
Re-exports encodeget
Re-exports getValueWithOptionsinitialize
Re-exports initializemiddleware
Re-exports middlewaremigrate
Re-exports migratenear
Renames and re-exports apiserialize
Re-exports serializeserialize
Re-exports serializeValueWithOptionsstr
Re-exports strvalidate
Re-exports validateAccountIdview
Re-exports viewGenerated using TypeDoc
Module near-bindgen
Index
Functions
Nearnear-bindgen | near-sdk-js - v2.0.0
Module near-bindgen
Index
Functions
Generated using TypeDoc
Generated using TypeDoc
Module promise
Index
Classes
Addpromise | near-sdk-js - v2.0.0
Module promise
Index
Classes
Type Aliases
Generated using TypeDoc
Generated using TypeDoc
Module types
Index
References
Accounttypes | near-sdk-js - v2.0.0
Account
Re-exports AccountIdBase58
Re-exports Base58ErrorBlock
Re-exports BlockHeightCurve
Re-exports CurveTypeEpoch
Re-exports EpochHeightGas
Re-exports GasWeightInvalid
Re-exports InvalidLengthErrorIterator
Re-exports IteratorIndexONE_
Re-exports ONE_NEARONE_
Re-exports ONE_TERA_GASONE_
Re-exports ONE_YOCTOParse
Re-exports ParsePublicKeyErrorPromise
Re-exports PromiseErrorPromise
Re-exports PromiseResultPublic
Re-exports PublicKeyReceipt
Re-exports ReceiptIndexStorage
Re-exports StorageUsageUnknown
Re-exports UnknownCurvecurve
Re-exports curveTypeFromStr
Module types
Index
References
Account
References
Account
Re-exports AccountIdBalance
Re-exports BalanceBase58
Re-exports Base58ErrorBlock
Re-exports BlockHeightCurve
Re-exports CurveTypeEpoch
Re-exports EpochHeightGas
Re-exports GasGas
Re-exports GasWeightInvalid
Re-exports InvalidLengthErrorIterator
Re-exports IteratorIndexNonce
Re-exports NonceONE_
Re-exports ONE_NEARONE_
Re-exports ONE_TERA_GASONE_
Re-exports ONE_YOCTOParse
Re-exports ParsePublicKeyErrorPromise
Re-exports PromiseErrorPromise
Re-exports PromiseResultPublic
Re-exports PublicKeyReceipt
Re-exports ReceiptIndexStorage
Re-exports StorageUsageUnknown
Re-exports UnknownCurvecurve
Re-exports curveTypeFromStrGenerated using TypeDoc
References
Account
Re-exports AccountIdBalance
Re-exports BalanceBase58
Re-exports Base58ErrorBlock
Re-exports BlockHeightCurve
Re-exports CurveTypeEpoch
Re-exports EpochHeightGas
Re-exports GasGas
Re-exports GasWeightInvalid
Re-exports InvalidLengthErrorIterator
Re-exports IteratorIndexNonce
Re-exports NonceONE_
Re-exports ONE_NEARONE_
Re-exports ONE_TERA_GASONE_
Re-exports ONE_YOCTOParse
Re-exports ParsePublicKeyErrorPromise
Re-exports PromiseErrorPromise
Re-exports PromiseResultPublic
Re-exports PublicKeyReceipt
Re-exports ReceiptIndexStorage
Re-exports StorageUsageUnknown
Re-exports UnknownCurvecurve
Re-exports curveTypeFromStrGenerated using TypeDoc
Module types/account_id
Index
Type Aliases
Generated using TypeDoc
Module types/account_id
Index
Type Aliases
Generated using TypeDoc
Module types/collections
Index
Interfaces
Generated using TypeDoc
Module types/collections
Index
Interfaces
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Module types/vm_types
Index
Enumerations
Promisetypes/vm_types | near-sdk-js - v2.0.0
Module types/vm_types
Index
Enumerations
Type Aliases
Generated using TypeDoc
Generated using TypeDoc
Module utils
Index
Classes
Textutils | near-sdk-js - v2.0.0
Module utils
Index
Classes
Interfaces
Generated using TypeDoc
Generated using TypeDoc
Module version
Index
Variables
Generated using TypeDoc
Module version
Index
Variables
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Type alias AccountId
Account
A string that represents a NEAR account ID.
-Generated using TypeDoc
Type alias AccountId
Account
A string that represents a NEAR account ID.
+Generated using TypeDoc
Type alias Gas
Gas: bigint
The Gas amount specified in yoctoNEAR.
-Generated using TypeDoc
Type alias Gas
Gas: bigint
The Gas amount specified in yoctoNEAR.
+Generated using TypeDoc
Type alias Balance
Balance: bigint
The amount of tokens in yoctoNEAR.
-Generated using TypeDoc
Type alias Balance
Balance: bigint
The amount of tokens in yoctoNEAR.
+Generated using TypeDoc
Type alias BlockHeight
Block
A large integer representing the block height.
-Generated using TypeDoc
Type alias BlockHeight
Block
A large integer representing the block height.
+Generated using TypeDoc
Type alias EpochHeight
Epoch
A large integer representing the epoch height.
-Generated using TypeDoc
Type alias EpochHeight
Epoch
A large integer representing the epoch height.
+Generated using TypeDoc
Type alias GasWeight
Gas
The amount of Gas Weight in integers - whole numbers.
-Generated using TypeDoc
Type alias GasWeight
Gas
The amount of Gas Weight in integers - whole numbers.
+Generated using TypeDoc
Type alias Nonce
Nonce: bigint
A large integer representing the nonce.
-Generated using TypeDoc
Type alias Nonce
Nonce: bigint
A large integer representing the nonce.
+Generated using TypeDoc
Type alias StorageUsage
Storage
The amount of storage used in yoctoNEAR.
-Generated using TypeDoc
Type alias StorageUsage
Storage
The amount of storage used in yoctoNEAR.
+Generated using TypeDoc
Type alias IteratorIndex
Iterator
The index for iterators.
-Generated using TypeDoc
Type alias IteratorIndex
Iterator
The index for iterators.
+Generated using TypeDoc
Type alias ReceiptIndex
Receipt
The index for NEAR receipts.
-Generated using TypeDoc
Type alias ReceiptIndex
Receipt
The index for NEAR receipts.
+Generated using TypeDoc
Type alias Mutable<T>
Mutable<T>: {
    -readonly [P in keyof T]: T[P]
}
    -readonly [P in keyof T]: T[P]
}
Type Parameters
T
Generated using TypeDoc
Type alias Mutable<T>
Mutable<T>: {
    -readonly [P in keyof T]: T[P]
}
    -readonly [P in keyof T]: T[P]
}
Type Parameters
T
Generated using TypeDoc
Type alias NearAmount
Near
A number that specifies the amount of NEAR in yoctoNEAR.
-Generated using TypeDoc
Type alias NearAmount
Near
A number that specifies the amount of NEAR in yoctoNEAR.
+Generated using TypeDoc
Type alias PromiseIndex
Promise
A PromiseIndex which represents the ID of a NEAR Promise.
-Generated using TypeDoc
Type alias PromiseIndex
Promise
A PromiseIndex which represents the ID of a NEAR Promise.
+Generated using TypeDoc
Type alias Register
Register: number | bigint
A number that specifies the ID of a register in the NEAR WASM virtual machine.
-Generated using TypeDoc
Type alias Register
Register: number | bigint
A number that specifies the ID of a register in the NEAR WASM virtual machine.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Variable ERR_INCONSISTENT_STATEConst
ERR_
Generated using TypeDoc
Variable ERR_INCONSISTENT_STATEConst
ERR_
Generated using TypeDoc
Variable ERR_INDEX_OUT_OF_BOUNDSConst
ERR_
Generated using TypeDoc
Variable ERR_INDEX_OUT_OF_BOUNDSConst
ERR_
Generated using TypeDoc
Variable LIB_VERSIONConst
LIB_
Generated using TypeDoc
Variable LIB_VERSIONConst
LIB_
Generated using TypeDoc
A lookup map that stores data in NEAR storage.
-