From 6872bf2f54cfa0a94dd9a59aedd21412ad3bd3d7 Mon Sep 17 00:00:00 2001 From: frol Date: Mon, 5 Aug 2024 07:05:23 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20near/nea?= =?UTF-8?q?r-sdk-js@451d598c071023ca4de32337cda7a10796a148f4=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/highlight.css | 46 ++++++++++++++++- classes/collections_lookup_map.LookupMap.html | 20 ++++---- classes/collections_lookup_set.LookupSet.html | 18 +++---- classes/collections_subtype.SubType.html | 4 +- ...ollections_unordered_map.UnorderedMap.html | 28 +++++------ ...ollections_unordered_set.UnorderedSet.html | 28 +++++------ classes/collections_vector.Vector.html | 32 ++++++------ .../collections_vector.VectorIterator.html | 8 +-- classes/promise.AddAccessKey.html | 16 +++--- classes/promise.AddFullAccessKey.html | 10 ++-- classes/promise.CreateAccount.html | 4 +- classes/promise.DeleteAccount.html | 8 +-- classes/promise.DeleteKey.html | 8 +-- classes/promise.DeployContract.html | 8 +-- classes/promise.FunctionCall.html | 14 +++--- classes/promise.FunctionCallRaw.html | 14 +++--- classes/promise.FunctionCallWeight.html | 16 +++--- classes/promise.FunctionCallWeightRaw.html | 16 +++--- classes/promise.NearPromise.html | 50 +++++++++---------- classes/promise.PromiseAction.html | 4 +- classes/promise.PromiseJoint.html | 4 +- classes/promise.Stake.html | 10 ++-- classes/promise.Transfer.html | 8 +-- classes/types_public_key.Base58Error.html | 4 +- .../types_public_key.InvalidLengthError.html | 4 +- .../types_public_key.ParsePublicKeyError.html | 2 +- classes/types_public_key.PublicKey.html | 10 ++-- classes/types_public_key.UnknownCurve.html | 4 +- classes/utils.TextDecoder.html | 4 +- classes/utils.TextEncoder.html | 4 +- enums/types_public_key.CurveType.html | 4 +- enums/types_vm_types.PromiseError.html | 4 +- enums/types_vm_types.PromiseResult.html | 4 +- functions/api.accountBalance.html | 2 +- functions/api.accountLockedBalance.html | 2 +- functions/api.altBn128G1Multiexp.html | 2 +- functions/api.altBn128G1Sum.html | 2 +- functions/api.altBn128PairingCheck.html | 2 +- functions/api.attachedDeposit.html | 2 +- functions/api.blockHeight.html | 2 +- functions/api.blockIndex.html | 2 +- functions/api.blockTimestamp.html | 2 +- functions/api.currentAccountId.html | 2 +- functions/api.ecrecover.html | 2 +- functions/api.epochHeight.html | 2 +- functions/api.input.html | 2 +- functions/api.inputRaw.html | 2 +- functions/api.keccak256.html | 2 +- functions/api.keccak512.html | 2 +- functions/api.log.html | 2 +- functions/api.logUtf16.html | 2 +- functions/api.logUtf8.html | 2 +- functions/api.panicUtf8.html | 2 +- functions/api.predecessorAccountId.html | 2 +- functions/api.prepaidGas.html | 2 +- functions/api.promiseAnd.html | 2 +- ...romiseBatchActionAddKeyWithFullAccess.html | 2 +- ...miseBatchActionAddKeyWithFunctionCall.html | 2 +- .../api.promiseBatchActionCreateAccount.html | 2 +- .../api.promiseBatchActionDeleteAccount.html | 2 +- .../api.promiseBatchActionDeleteKey.html | 2 +- .../api.promiseBatchActionDeployContract.html | 2 +- .../api.promiseBatchActionFunctionCall.html | 2 +- ...api.promiseBatchActionFunctionCallRaw.html | 2 +- ....promiseBatchActionFunctionCallWeight.html | 2 +- ...omiseBatchActionFunctionCallWeightRaw.html | 2 +- functions/api.promiseBatchActionStake.html | 2 +- functions/api.promiseBatchActionTransfer.html | 2 +- functions/api.promiseBatchCreate.html | 2 +- functions/api.promiseBatchThen.html | 2 +- functions/api.promiseCreate.html | 2 +- functions/api.promiseCreateRaw.html | 2 +- functions/api.promiseResult.html | 2 +- functions/api.promiseResultRaw.html | 2 +- functions/api.promiseResultsCount.html | 2 +- functions/api.promiseReturn.html | 2 +- functions/api.promiseThen.html | 2 +- functions/api.promiseThenRaw.html | 2 +- functions/api.randomSeed.html | 2 +- functions/api.ripemd160.html | 2 +- functions/api.sha256.html | 2 +- functions/api.signerAccountId.html | 2 +- functions/api.signerAccountPk.html | 2 +- functions/api.storageByteCost.html | 2 +- functions/api.storageGetEvicted.html | 2 +- functions/api.storageGetEvictedRaw.html | 2 +- functions/api.storageHasKey.html | 2 +- functions/api.storageHasKeyRaw.html | 2 +- functions/api.storageRead.html | 2 +- functions/api.storageReadRaw.html | 2 +- functions/api.storageRemove.html | 2 +- functions/api.storageRemoveRaw.html | 2 +- functions/api.storageUsage.html | 2 +- functions/api.storageWrite.html | 2 +- functions/api.storageWriteRaw.html | 2 +- functions/api.usedGas.html | 2 +- functions/api.validatorStake.html | 2 +- functions/api.validatorTotalStake.html | 2 +- functions/api.valueReturn.html | 2 +- functions/api.valueReturnRaw.html | 2 +- functions/cli_abi.runAbiCompilerPlugin.html | 2 +- ...cli_build_tools_include_bytes.default.html | 2 +- ...d_tools_near_bindgen_exporter.default.html | 2 +- functions/cli_cli.buildCom.html | 2 +- functions/cli_cli.checkTypescriptCom.html | 2 +- .../cli_cli.createJsFileWithRollupCom.html | 2 +- functions/cli_cli.generateAbi.html | 2 +- .../cli_cli.transpileJsAndBuildWasmCom.html | 2 +- functions/cli_cli.validateCom.html | 2 +- functions/cli_utils.download.html | 2 +- functions/cli_utils.executeCommand.html | 2 +- functions/cli_utils.validateContract.html | 2 +- functions/index.includeBytes.html | 2 +- functions/near_bindgen.NearBindgen.html | 4 +- functions/near_bindgen.call.html | 2 +- functions/near_bindgen.initialize.html | 2 +- functions/near_bindgen.middleware.html | 2 +- functions/near_bindgen.migrate.html | 2 +- functions/near_bindgen.view.html | 2 +- .../types_public_key.curveTypeFromStr.html | 2 +- functions/utils.assert.html | 2 +- functions/utils.bytes.html | 2 +- functions/utils.concat.html | 2 +- functions/utils.decode.html | 2 +- functions/utils.decodeObj2class.html | 2 +- functions/utils.deserialize.html | 2 +- functions/utils.encode.html | 2 +- functions/utils.getValueWithOptions.html | 2 +- functions/utils.serialize.html | 2 +- .../utils.serializeValueWithOptions.html | 2 +- functions/utils.str.html | 2 +- functions/utils.validateAccountId.html | 2 +- index.html | 29 ++++++----- interfaces/types_collections.GetOptions.html | 10 ++-- interfaces/utils.Env.html | 4 +- interfaces/utils.IntoStorageKey.html | 4 +- modules/api.html | 2 +- modules/cli_abi.html | 2 +- modules/cli_build_tools_include_bytes.html | 2 +- ...cli_build_tools_near_bindgen_exporter.html | 2 +- modules/cli_cli.html | 2 +- modules/cli_post_install.html | 2 +- modules/cli_utils.html | 2 +- modules/collections.html | 2 +- modules/collections_lookup_map.html | 2 +- modules/collections_lookup_set.html | 2 +- modules/collections_subtype.html | 2 +- modules/collections_unordered_map.html | 2 +- modules/collections_unordered_set.html | 2 +- modules/collections_vector.html | 2 +- modules/index.html | 2 +- modules/near_bindgen.html | 2 +- modules/promise.html | 2 +- modules/types.html | 2 +- modules/types_account_id.html | 2 +- modules/types_collections.html | 2 +- modules/types_gas.html | 2 +- modules/types_primitives.html | 2 +- modules/types_public_key.html | 2 +- modules/types_vm_types.html | 2 +- modules/utils.html | 2 +- modules/version.html | 2 +- types/promise.PromiseOrValue.html | 2 +- types/types_account_id.AccountId.html | 2 +- types/types_gas.Gas.html | 2 +- types/types_primitives.Balance.html | 2 +- types/types_primitives.BlockHeight.html | 2 +- types/types_primitives.EpochHeight.html | 2 +- types/types_primitives.GasWeight.html | 2 +- types/types_primitives.Nonce.html | 2 +- types/types_primitives.StorageUsage.html | 2 +- types/types_vm_types.IteratorIndex.html | 2 +- types/types_vm_types.ReceiptIndex.html | 2 +- types/utils.Mutable.html | 2 +- types/utils.NearAmount.html | 2 +- types/utils.PromiseIndex.html | 2 +- types/utils.Register.html | 2 +- variables/types_gas.ONE_TERA_GAS.html | 2 +- variables/types_primitives.ONE_NEAR.html | 2 +- variables/types_primitives.ONE_YOCTO.html | 2 +- variables/utils.ERR_INCONSISTENT_STATE.html | 2 +- variables/utils.ERR_INDEX_OUT_OF_BOUNDS.html | 2 +- variables/version.LIB_VERSION.html | 2 +- 183 files changed, 402 insertions(+), 357 deletions(-) diff --git a/assets/highlight.css b/assets/highlight.css index a2f1712d..190f1df4 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -1,8 +1,20 @@ :root { - --light-hl-0: #001080; - --dark-hl-0: #9CDCFE; + --light-hl-0: #AF00DB; + --dark-hl-0: #C586C0; --light-hl-1: #000000; --dark-hl-1: #D4D4D4; + --light-hl-2: #001080; + --dark-hl-2: #9CDCFE; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #795E26; + --dark-hl-4: #DCDCAA; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #267F99; + --dark-hl-6: #4EC9B0; + --light-hl-7: #008000; + --dark-hl-7: #6A9955; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -10,27 +22,57 @@ @media (prefers-color-scheme: light) { :root { --hl-0: var(--light-hl-0); --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); --code-background: var(--light-code-background); } } @media (prefers-color-scheme: dark) { :root { --hl-0: var(--dark-hl-0); --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); --code-background: var(--dark-code-background); } } :root[data-theme='light'] { --hl-0: var(--light-hl-0); --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); --code-background: var(--light-code-background); } :root[data-theme='dark'] { --hl-0: var(--dark-hl-0); --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); --code-background: var(--dark-code-background); } .hl-0 { color: var(--hl-0); } .hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } pre, code { background: var(--code-background); } diff --git a/classes/collections_lookup_map.LookupMap.html b/classes/collections_lookup_map.LookupMap.html index 93147941..45dc22cc 100644 --- a/classes/collections_lookup_map.LookupMap.html +++ b/classes/collections_lookup_map.LookupMap.html @@ -1,5 +1,5 @@ LookupMap | near-sdk-js - v2.0.0

Class LookupMap<DataType>

A lookup map that stores data in NEAR storage.

-

Type Parameters

  • DataType

Hierarchy

Constructors

constructor +

Type Parameters

  • DataType

Hierarchy

Constructors

constructor

Properties

keyPrefix

Methods

containsKey extend @@ -11,24 +11,24 @@ subtype reconstruct

Constructors

constructor

Properties

Readonly keyPrefix

keyPrefix: string

The byte prefix to use when storing elements inside this collection.

-

Methods

containsKey

  • containsKey(key): boolean

  • Checks whether the collection contains the value.

    +

Returns LookupMap<DataType>

Properties

Readonly keyPrefix

keyPrefix: string

The byte prefix to use when storing elements inside this collection.

+

Methods

containsKey

extend

  • extend(keyValuePairs, options?): void

  • Extends the current collection with the passed in array of key-value pairs.

    +

Returns boolean

extend

  • extend(keyValuePairs, options?): void

  • Extends the current collection with the passed in array of key-value pairs.

    Parameters

    • keyValuePairs: [string, DataType][]

      The key-value pairs to extend the collection with.

    • Optional options: GetOptions<DataType>

      Options for storing the data.

      -

    Returns void

get

  • get(key, options?): DataType

  • Get the data stored at the provided key.

    +

Returns void

get

remove

Returns DataType

remove

serialize

Returns DataType

serialize

set

Returns Uint8Array

set

set_reconstructor

subtype

Static reconstruct

Returns DataType

set_reconstructor

subtype

Static reconstruct

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns LookupMap<DataType>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/collections_lookup_set.LookupSet.html b/classes/collections_lookup_set.LookupSet.html index fc2c8e7d..ddeb8618 100644 --- a/classes/collections_lookup_set.LookupSet.html +++ b/classes/collections_lookup_set.LookupSet.html @@ -1,5 +1,5 @@ LookupSet | near-sdk-js - v2.0.0

Class LookupSet<DataType>

A lookup set collection that stores entries in NEAR storage.

-

Type Parameters

  • DataType

Constructors

constructor +

Type Parameters

  • DataType

Constructors

constructor

Properties

keyPrefix

Methods

contains extend @@ -8,22 +8,22 @@ set reconstruct

Constructors

constructor

Properties

Readonly keyPrefix

keyPrefix: string

The byte prefix to use when storing elements inside this collection.

-

Methods

contains

  • contains(key, options?): boolean

  • Checks whether the collection contains the value.

    +

Returns LookupSet<DataType>

Properties

Readonly keyPrefix

keyPrefix: string

The byte prefix to use when storing elements inside this collection.

+

Methods

contains

extend

  • extend(keys, options?): void

  • Extends the current collection with the passed in array of elements.

    +

Returns boolean

extend

  • extend(keys, options?): void

  • Extends the current collection with the passed in array of elements.

    Parameters

    • keys: DataType[]

      The elements to extend the collection with.

    • Optional options: Pick<GetOptions<DataType>, "serializer">

      Options for storing the data.

      -

    Returns void

remove

  • remove(key, options?): boolean

  • Returns true if the element was present in the set.

    +

Returns void

remove

serialize

Returns boolean

serialize

set

Returns Uint8Array

set

Static reconstruct

Returns boolean

Static reconstruct

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns LookupSet<DataType>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/collections_subtype.SubType.html b/classes/collections_subtype.SubType.html index 96fd203a..d86d1401 100644 --- a/classes/collections_subtype.SubType.html +++ b/classes/collections_subtype.SubType.html @@ -1,4 +1,4 @@ -SubType | near-sdk-js - v2.0.0

Class SubType<DataType>Abstract

Type Parameters

  • DataType

Hierarchy

Constructors

constructor +SubType | near-sdk-js - v2.0.0

Class SubType<DataType>Abstract

Type Parameters

  • DataType

Hierarchy

Constructors

constructor

Methods

set_reconstructor subtype -

Constructors

constructor

  • new SubType<DataType>(): SubType<DataType>

  • Type Parameters

    • DataType

    Returns SubType<DataType>

Methods

set_reconstructor

subtype

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new SubType<DataType>(): SubType<DataType>

  • Type Parameters

    • DataType

    Returns SubType<DataType>

Methods

set_reconstructor

subtype

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/collections_unordered_map.UnorderedMap.html b/classes/collections_unordered_map.UnorderedMap.html index c6e7cfdd..dc83ce16 100644 --- a/classes/collections_unordered_map.UnorderedMap.html +++ b/classes/collections_unordered_map.UnorderedMap.html @@ -1,5 +1,5 @@ UnorderedMap | near-sdk-js - v2.0.0

Class UnorderedMap<DataType>

An unordered map that stores data in NEAR storage.

-

Type Parameters

  • DataType

Hierarchy

Constructors

constructor +

Type Parameters

  • DataType

Hierarchy

Constructors

constructor

Properties

_keys prefix values @@ -19,28 +19,28 @@ toArray reconstruct

Constructors

constructor

Properties

Readonly _keys

_keys: Vector<string>

Readonly prefix

prefix: string

The byte prefix to use when storing elements inside this collection.

-

Readonly values

values: LookupMap<ValueAndIndex>

Accessors

length

Methods

[iterator]

clear

Private createIteratorWithOptions

  • createIteratorWithOptions(options?): {
        [iterator](): UnorderedMapIterator<DataType>;
    }

  • Create a iterator on top of the default collection iterator using custom options.

    +

Returns UnorderedMap<DataType>

Properties

Readonly _keys

_keys: Vector<string>

Readonly prefix

prefix: string

The byte prefix to use when storing elements inside this collection.

+

Readonly values

values: LookupMap<ValueAndIndex>

Accessors

length

Methods

[iterator]

clear

Private createIteratorWithOptions

extend

  • extend(keyValuePairs): void

  • Extends the current collection with the passed in array of key-value pairs.

    +

Returns {
    [iterator](): UnorderedMapIterator<DataType>;
}

extend

get

  • get(key, options?): DataType

  • Get the data stored at the provided key.

    +

Returns void

get

isEmpty

keys

remove

Returns DataType

isEmpty

keys

remove

serialize

Returns DataType

serialize

set

Returns Uint8Array

set

set_reconstructor

subtype

toArray

Returns DataType

set_reconstructor

subtype

toArray

Static reconstruct

Returns [string, DataType][]

Static reconstruct

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns UnorderedMap<DataType>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/collections_unordered_set.UnorderedSet.html b/classes/collections_unordered_set.UnorderedSet.html index 415f262a..07d5d456 100644 --- a/classes/collections_unordered_set.UnorderedSet.html +++ b/classes/collections_unordered_set.UnorderedSet.html @@ -1,5 +1,5 @@ UnorderedSet | near-sdk-js - v2.0.0

Class UnorderedSet<DataType>

An unordered set that stores data in NEAR storage.

-

Type Parameters

  • DataType

Constructors

constructor +

Type Parameters

  • DataType

Constructors

constructor

Properties

_elements elementIndexPrefix prefix @@ -17,28 +17,28 @@ toArray reconstruct

Constructors

constructor

Properties

Readonly _elements

_elements: Vector<DataType>

Readonly elementIndexPrefix

elementIndexPrefix: string

Readonly prefix

prefix: string

The byte prefix to use when storing elements inside this collection.

-

Accessors

length

Methods

[iterator]

clear

contains

  • contains(element, options?): boolean

  • Checks whether the collection contains the value.

    +

Returns UnorderedSet<DataType>

Properties

Readonly _elements

_elements: Vector<DataType>

Readonly elementIndexPrefix

elementIndexPrefix: string

Readonly prefix

prefix: string

The byte prefix to use when storing elements inside this collection.

+

Accessors

length

Methods

[iterator]

clear

contains

Private createIteratorWithOptions

  • createIteratorWithOptions(options?): {
        [iterator](): VectorIterator<DataType>;
    }

  • Create a iterator on top of the default collection iterator using custom options.

    +

Returns boolean

Private createIteratorWithOptions

elements

extend

  • extend(elements): void

  • Extends the current collection with the passed in array of elements.

    +

Returns {
    [iterator](): VectorIterator<DataType>;
}

elements

extend

isEmpty

remove

Returns void

isEmpty

remove

serialize

Returns boolean

serialize

set

Returns Uint8Array

set

toArray

Returns boolean

toArray

Static reconstruct

Returns DataType[]

Static reconstruct

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns UnorderedSet<DataType>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/collections_vector.Vector.html b/classes/collections_vector.Vector.html index 82bcc1ae..39df4eff 100644 --- a/classes/collections_vector.Vector.html +++ b/classes/collections_vector.Vector.html @@ -1,6 +1,6 @@ Vector | near-sdk-js - v2.0.0

Class Vector<DataType>

An iterable implementation of vector that stores its content on the trie. Uses the following map: index -> element

-

Type Parameters

  • DataType

Hierarchy

Constructors

constructor +

Type Parameters

  • DataType

Hierarchy

Constructors

constructor

Properties

length prefix

Methods

[iterator] @@ -20,35 +20,35 @@ reconstruct

Constructors

constructor

Properties

length

length: number = 0

The initial length of the collection. By default 0.

-

Readonly prefix

prefix: string

The byte prefix to use when storing elements inside this collection.

-

Methods

[iterator]

clear

Private createIteratorWithOptions

  • createIteratorWithOptions(options?): {
        [iterator](): VectorIterator<DataType>;
    }

  • Create a iterator on top of the default collection iterator using custom options.

    +

Returns Vector<DataType>

Properties

length

length: number = 0

The initial length of the collection. By default 0.

+

Readonly prefix

prefix: string

The byte prefix to use when storing elements inside this collection.

+

Methods

[iterator]

clear

Private createIteratorWithOptions

extend

  • extend(elements): void

  • Extends the current collection with the passed in array of elements.

    +

Returns {
    [iterator](): VectorIterator<DataType>;
}

extend

get

  • get(index, options?): DataType

  • Get the data stored at the provided index.

    +

Returns void

get

isEmpty

pop

Returns DataType

isEmpty

pop

push

Returns DataType

push

replace

Returns void

replace

serialize

Returns DataType

serialize

set_reconstructor

subtype

swapRemove

Returns Uint8Array

set_reconstructor

subtype

swapRemove

toArray

Returns DataType

toArray

Static reconstruct

Returns DataType[]

Static reconstruct

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Vector<DataType>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/collections_vector.VectorIterator.html b/classes/collections_vector.VectorIterator.html index 705972b4..209d124e 100644 --- a/classes/collections_vector.VectorIterator.html +++ b/classes/collections_vector.VectorIterator.html @@ -1,11 +1,11 @@ VectorIterator | near-sdk-js - v2.0.0

Class VectorIterator<DataType>

An iterator for the Vector collection.

-

Type Parameters

  • DataType

Constructors

constructor +

Type Parameters

  • DataType

Constructors

constructor

Properties

current options? vector

Methods

next

Constructors

constructor

Properties

Private current

current: number = 0

Private Optional Readonly options

options?: GetOptions<DataType>

Options for retrieving and storing data.

-

Private vector

vector: Vector<DataType>

The vector collection to create an iterator for.

-

Methods

next

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns VectorIterator<DataType>

Properties

Private current

current: number = 0

Private Optional Readonly options

options?: GetOptions<DataType>

Options for retrieving and storing data.

+

Private vector

vector: Vector<DataType>

The vector collection to create an iterator for.

+

Methods

next

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/promise.AddAccessKey.html b/classes/promise.AddAccessKey.html index 6d74ae26..9c6fa1cc 100644 --- a/classes/promise.AddAccessKey.html +++ b/classes/promise.AddAccessKey.html @@ -1,5 +1,5 @@ AddAccessKey | near-sdk-js - v2.0.0

Class AddAccessKey

A add access key promise action.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

allowance functionNames nonce @@ -11,11 +11,11 @@
  • receiverId: string

    The account ID of the receiver.

  • functionNames: string

    The names of funcitons to authorize.

  • nonce: bigint

    The nonce to use.

    -

    • Returns AddAccessKey

    Properties

    allowance

    allowance: bigint

    The allowance for the key in yoctoNEAR.

    -

    functionNames

    functionNames: string

    The names of funcitons to authorize.

    -

    nonce

    nonce: bigint

    The nonce to use.

    -

    publicKey

    publicKey: PublicKey

    The public key to add as a access key.

    -

    receiverId

    receiverId: string

    The account ID of the receiver.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns AddAccessKey

    Properties

    allowance

    allowance: bigint

    The allowance for the key in yoctoNEAR.

    +

    functionNames

    functionNames: string

    The names of funcitons to authorize.

    +

    nonce

    nonce: bigint

    The nonce to use.

    +

    publicKey

    publicKey: PublicKey

    The public key to add as a access key.

    +

    receiverId

    receiverId: string

    The account ID of the receiver.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.AddFullAccessKey.html b/classes/promise.AddFullAccessKey.html index 5e426391..5fb55d59 100644 --- a/classes/promise.AddFullAccessKey.html +++ b/classes/promise.AddFullAccessKey.html @@ -1,12 +1,12 @@ AddFullAccessKey | near-sdk-js - v2.0.0

    Class AddFullAccessKey

    A add full access key promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    nonce publicKey

    Methods

    add

    Constructors

    constructor

    Properties

    nonce

    nonce: bigint

    The nonce to use.

    -

    publicKey

    publicKey: PublicKey

    The public key to add as a full access key.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns AddFullAccessKey

    Properties

    nonce

    nonce: bigint

    The nonce to use.

    +

    publicKey

    publicKey: PublicKey

    The public key to add as a full access key.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.CreateAccount.html b/classes/promise.CreateAccount.html index e1c3825d..ce4bf93b 100644 --- a/classes/promise.CreateAccount.html +++ b/classes/promise.CreateAccount.html @@ -1,6 +1,6 @@ CreateAccount | near-sdk-js - v2.0.0

    Class CreateAccount

    A create account promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Methods

    add

    Constructors

    constructor

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.DeleteAccount.html b/classes/promise.DeleteAccount.html index 18e319ef..24dab804 100644 --- a/classes/promise.DeleteAccount.html +++ b/classes/promise.DeleteAccount.html @@ -1,9 +1,9 @@ DeleteAccount | near-sdk-js - v2.0.0

    Class DeleteAccount

    A delete account promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    beneficiaryId

    Methods

    add

    Constructors

    constructor

    Properties

    beneficiaryId

    beneficiaryId: string

    The beneficiary of the account deletion - the account to recieve all of the remaining funds of the deleted account.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns DeleteAccount

    Properties

    beneficiaryId

    beneficiaryId: string

    The beneficiary of the account deletion - the account to recieve all of the remaining funds of the deleted account.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.DeleteKey.html b/classes/promise.DeleteKey.html index 5929e7ef..9ea7e299 100644 --- a/classes/promise.DeleteKey.html +++ b/classes/promise.DeleteKey.html @@ -1,9 +1,9 @@ DeleteKey | near-sdk-js - v2.0.0

    Class DeleteKey

    A delete key promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    publicKey

    Methods

    add

    Constructors

    constructor

    Properties

    publicKey

    publicKey: PublicKey

    The public key to delete from the account.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns DeleteKey

    Properties

    publicKey

    publicKey: PublicKey

    The public key to delete from the account.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.DeployContract.html b/classes/promise.DeployContract.html index be7cb6d2..6aa8c55c 100644 --- a/classes/promise.DeployContract.html +++ b/classes/promise.DeployContract.html @@ -1,9 +1,9 @@ DeployContract | near-sdk-js - v2.0.0

    Class DeployContract

    A deploy contract promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    code

    Methods

    add

    Constructors

    constructor

    Properties

    code

    code: Uint8Array

    The code of the contract to be deployed.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns DeployContract

    Properties

    code

    code: Uint8Array

    The code of the contract to be deployed.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.FunctionCall.html b/classes/promise.FunctionCall.html index 615febf6..fb3f1735 100644 --- a/classes/promise.FunctionCall.html +++ b/classes/promise.FunctionCall.html @@ -1,5 +1,5 @@ FunctionCall | near-sdk-js - v2.0.0

    Class FunctionCall

    A function call promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    amount args functionName @@ -9,10 +9,10 @@
  • args: string

    The utf-8 string arguments to be passed to the function.

  • amount: bigint

    The amount of NEAR to attach to the call.

  • gas: bigint

    The amount of Gas to attach to the call.

    -

    • Returns FunctionCall

    Properties

    amount

    amount: bigint

    The amount of NEAR to attach to the call.

    -

    args

    args: string

    The utf-8 string arguments to be passed to the function.

    -

    functionName

    functionName: string

    The name of the function to be called.

    -

    gas

    gas: bigint

    The amount of Gas to attach to the call.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns FunctionCall

    Properties

    amount

    amount: bigint

    The amount of NEAR to attach to the call.

    +

    args

    args: string

    The utf-8 string arguments to be passed to the function.

    +

    functionName

    functionName: string

    The name of the function to be called.

    +

    gas

    gas: bigint

    The amount of Gas to attach to the call.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.FunctionCallRaw.html b/classes/promise.FunctionCallRaw.html index dbfcf676..d1017455 100644 --- a/classes/promise.FunctionCallRaw.html +++ b/classes/promise.FunctionCallRaw.html @@ -1,5 +1,5 @@ FunctionCallRaw | near-sdk-js - v2.0.0

    Class FunctionCallRaw

    A function call raw promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    amount args functionName @@ -9,10 +9,10 @@
  • args: Uint8Array

    The arguments to be passed to the function.

  • amount: bigint

    The amount of NEAR to attach to the call.

  • gas: bigint

    The amount of Gas to attach to the call.

    -

    • Returns FunctionCallRaw

    Properties

    amount

    amount: bigint

    The amount of NEAR to attach to the call.

    -

    args

    args: Uint8Array

    The arguments to be passed to the function.

    -

    functionName

    functionName: string

    The name of the function to be called.

    -

    gas

    gas: bigint

    The amount of Gas to attach to the call.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns FunctionCallRaw

    Properties

    amount

    amount: bigint

    The amount of NEAR to attach to the call.

    +

    args

    args: Uint8Array

    The arguments to be passed to the function.

    +

    functionName

    functionName: string

    The name of the function to be called.

    +

    gas

    gas: bigint

    The amount of Gas to attach to the call.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.FunctionCallWeight.html b/classes/promise.FunctionCallWeight.html index 358446b5..a7a3c41a 100644 --- a/classes/promise.FunctionCallWeight.html +++ b/classes/promise.FunctionCallWeight.html @@ -1,5 +1,5 @@ FunctionCallWeight | near-sdk-js - v2.0.0

    Class FunctionCallWeight

    A function call weight promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    amount args functionName @@ -11,11 +11,11 @@
  • amount: bigint

    The amount of NEAR to attach to the call.

  • gas: bigint

    The amount of Gas to attach to the call.

  • weight: bigint

    The weight of unused Gas to use.

    -

    • Returns FunctionCallWeight

    Properties

    amount

    amount: bigint

    The amount of NEAR to attach to the call.

    -

    args

    args: string

    The utf-8 string arguments to be passed to the function.

    -

    functionName

    functionName: string

    The name of the function to be called.

    -

    gas

    gas: bigint

    The amount of Gas to attach to the call.

    -

    weight

    weight: bigint

    The weight of unused Gas to use.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns FunctionCallWeight

    Properties

    amount

    amount: bigint

    The amount of NEAR to attach to the call.

    +

    args

    args: string

    The utf-8 string arguments to be passed to the function.

    +

    functionName

    functionName: string

    The name of the function to be called.

    +

    gas

    gas: bigint

    The amount of Gas to attach to the call.

    +

    weight

    weight: bigint

    The weight of unused Gas to use.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.FunctionCallWeightRaw.html b/classes/promise.FunctionCallWeightRaw.html index 99950c2d..0a554b79 100644 --- a/classes/promise.FunctionCallWeightRaw.html +++ b/classes/promise.FunctionCallWeightRaw.html @@ -1,5 +1,5 @@ FunctionCallWeightRaw | near-sdk-js - v2.0.0

    Class FunctionCallWeightRaw

    A function call weight raw promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    amount args functionName @@ -11,11 +11,11 @@
  • amount: bigint

    The amount of NEAR to attach to the call.

  • gas: bigint

    The amount of Gas to attach to the call.

  • weight: bigint

    The weight of unused Gas to use.

    -

    • Returns FunctionCallWeightRaw

    Properties

    amount

    amount: bigint

    The amount of NEAR to attach to the call.

    -

    args

    args: Uint8Array

    The arguments to be passed to the function.

    -

    functionName

    functionName: string

    The name of the function to be called.

    -

    gas

    gas: bigint

    The amount of Gas to attach to the call.

    -

    weight

    weight: bigint

    The weight of unused Gas to use.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns FunctionCallWeightRaw

    Properties

    amount

    amount: bigint

    The amount of NEAR to attach to the call.

    +

    args

    args: Uint8Array

    The arguments to be passed to the function.

    +

    functionName

    functionName: string

    The name of the function to be called.

    +

    gas

    gas: bigint

    The amount of Gas to attach to the call.

    +

    weight

    weight: bigint

    The weight of unused Gas to use.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.NearPromise.html b/classes/promise.NearPromise.html index 8a8eaa5e..5bc7a659 100644 --- a/classes/promise.NearPromise.html +++ b/classes/promise.NearPromise.html @@ -1,5 +1,5 @@ NearPromise | near-sdk-js - v2.0.0

    Class NearPromise

    A high level class to construct and work with NEAR promises.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    shouldReturn subtype

    Methods

    addAccessKey @@ -26,73 +26,73 @@ new

    Constructors

    constructor

    Properties

    Private shouldReturn

    shouldReturn: boolean

    Whether the promise should return.

    -

    Private subtype

    subtype: PromiseSubtype

    The subtype of the promise.

    -

    Methods

    addAccessKey

    • addAccessKey(publicKey, allowance, receiverId, functionNames): NearPromise

    • Creates a add access key promise action and adds it to the current promise. +

    Returns NearPromise

    Properties

    Private shouldReturn

    shouldReturn: boolean

    Whether the promise should return.

    +

    Private subtype

    subtype: PromiseSubtype

    The subtype of the promise.

    +

    Methods

    addAccessKey

    • addAccessKey(publicKey, allowance, receiverId, functionNames): NearPromise

    • Creates a add access key promise action and adds it to the current promise. Uses 0n as the nonce.

      Parameters

      • publicKey: PublicKey

        The public key to add as a access key.

      • allowance: bigint

        The allowance for the key in yoctoNEAR.

      • receiverId: string

        The account ID of the receiver.

      • functionNames: string

        The names of funcitons to authorize.

        -

      Returns NearPromise

    addAccessKeyWithNonce

    • addAccessKeyWithNonce(publicKey, allowance, receiverId, functionNames, nonce): NearPromise

    • Creates a add access key promise action and adds it to the current promise. +

    Returns NearPromise

    addAccessKeyWithNonce

    • addAccessKeyWithNonce(publicKey, allowance, receiverId, functionNames, nonce): NearPromise

    • Creates a add access key promise action and adds it to the current promise. Allows you to specify the nonce.

      Parameters

      • publicKey: PublicKey

        The public key to add as a access key.

      • allowance: bigint

        The allowance for the key in yoctoNEAR.

      • receiverId: string

        The account ID of the receiver.

      • functionNames: string

        The names of funcitons to authorize.

      • nonce: bigint

        The nonce to use.

        -

      Returns NearPromise

    Private addAction

    addFullAccessKey

    • addFullAccessKey(publicKey): NearPromise

    • Creates a add full access key promise action and adds it to the current promise. +

    Returns NearPromise

    Private addAction

    addFullAccessKey

    addFullAccessKeyWithNonce

    Returns NearPromise

    addFullAccessKeyWithNonce

    and

    Returns NearPromise

    and

    asReturn

    build

    Returns NearPromise

    asReturn

    build

    constructRecursively

    createAccount

    deleteAccount

    constructRecursively

    createAccount

    deleteAccount

    deleteKey

    Returns NearPromise

    deleteKey

    deployContract

    Returns NearPromise

    deployContract

    functionCall

    Returns NearPromise

    functionCall

    functionCallRaw

    Returns NearPromise

    functionCallRaw

    functionCallWeight

    Returns NearPromise

    functionCallWeight

    functionCallWeightRaw

    Returns NearPromise

    functionCallWeightRaw

    onReturn

    stake

    Returns NearPromise

    onReturn

    stake

    then

    Returns NearPromise

    then

    transfer

    Returns NearPromise

    transfer

    Static new

    Returns NearPromise

    Static new

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns NearPromise

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.PromiseAction.html b/classes/promise.PromiseAction.html index 7d08de27..2e8de88e 100644 --- a/classes/promise.PromiseAction.html +++ b/classes/promise.PromiseAction.html @@ -1,6 +1,6 @@ PromiseAction | near-sdk-js - v2.0.0

    Class PromiseActionAbstract

    A promise action which can be executed on the NEAR blockchain.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Methods

    add

    Constructors

    constructor

    Methods

    Abstract add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      Parameters

      • promiseIndex: PromiseIndex

        The index of the promise batch to attach the action to.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.PromiseJoint.html b/classes/promise.PromiseJoint.html index 9f10d324..a6408380 100644 --- a/classes/promise.PromiseJoint.html +++ b/classes/promise.PromiseJoint.html @@ -1,6 +1,6 @@ -PromiseJoint | near-sdk-js - v2.0.0

    Class PromiseJoint

    Constructors

    constructor +PromiseJoint | near-sdk-js - v2.0.0

    Class PromiseJoint

    Constructors

    constructor

    Properties

    promiseA promiseB promiseIndex

    Methods

    constructRecursively -

    Constructors

    constructor

    Properties

    promiseA

    promiseA: NearPromise

    promiseB

    promiseB: NearPromise

    promiseIndex

    promiseIndex: PromiseIndex

    Methods

    constructRecursively

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    promiseA

    promiseA: NearPromise

    promiseB

    promiseB: NearPromise

    promiseIndex

    promiseIndex: PromiseIndex

    Methods

    constructRecursively

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.Stake.html b/classes/promise.Stake.html index 4117f500..21bd8ef9 100644 --- a/classes/promise.Stake.html +++ b/classes/promise.Stake.html @@ -1,12 +1,12 @@ Stake | near-sdk-js - v2.0.0

    Class Stake

    A stake promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    amount publicKey

    Methods

    add

    Constructors

    constructor

    Properties

    amount

    amount: bigint

    The amount of NEAR to tranfer.

    -

    publicKey

    publicKey: PublicKey

    The public key to use for staking.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns Stake

    Properties

    amount

    amount: bigint

    The amount of NEAR to tranfer.

    +

    publicKey

    publicKey: PublicKey

    The public key to use for staking.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/promise.Transfer.html b/classes/promise.Transfer.html index 9070d13b..e24ffd83 100644 --- a/classes/promise.Transfer.html +++ b/classes/promise.Transfer.html @@ -1,9 +1,9 @@ Transfer | near-sdk-js - v2.0.0

    Class Transfer

    A transfer promise action.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    amount

    Methods

    add

    Constructors

    constructor

    Properties

    amount

    amount: bigint

    The amount of NEAR to tranfer.

    -

    Methods

    add

    • add(promiseIndex): void

    • The method that describes how a promise action adds it's action to the promise batch with the provided index.

      +

    Returns Transfer

    Properties

    amount

    amount: bigint

    The amount of NEAR to tranfer.

    +

    Methods

    add

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/types_public_key.Base58Error.html b/classes/types_public_key.Base58Error.html index 3c2a89d6..034c09a7 100644 --- a/classes/types_public_key.Base58Error.html +++ b/classes/types_public_key.Base58Error.html @@ -1,4 +1,4 @@ -Base58Error | near-sdk-js - v2.0.0

    Class Base58Error

    Hierarchy

    Constructors

    constructor +Base58Error | near-sdk-js - v2.0.0

    Class Base58Error

    Hierarchy

    Constructors

    constructor

    Properties

    cause? error message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    Optional cause

    cause?: Error

    error

    error: string

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Optional cause

    cause?: Error

    error

    error: string

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/types_public_key.InvalidLengthError.html b/classes/types_public_key.InvalidLengthError.html index 890543b6..966e5001 100644 --- a/classes/types_public_key.InvalidLengthError.html +++ b/classes/types_public_key.InvalidLengthError.html @@ -1,4 +1,4 @@ -InvalidLengthError | near-sdk-js - v2.0.0

    Class InvalidLengthError

    Hierarchy

    Constructors

    constructor +InvalidLengthError | near-sdk-js - v2.0.0

    Class InvalidLengthError

    Hierarchy

    Constructors

    constructor

    Properties

    cause? expectedLength length @@ -8,7 +8,7 @@ prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    Optional cause

    cause?: Error

    expectedLength

    expectedLength: number

    length

    length: number

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Optional cause

    cause?: Error

    expectedLength

    expectedLength: number

    length

    length: number

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/types_public_key.ParsePublicKeyError.html b/classes/types_public_key.ParsePublicKeyError.html index 97cfc42c..f1a7ace5 100644 --- a/classes/types_public_key.ParsePublicKeyError.html +++ b/classes/types_public_key.ParsePublicKeyError.html @@ -1,4 +1,4 @@ -ParsePublicKeyError | near-sdk-js - v2.0.0

    Class ParsePublicKeyError

    Hierarchy

    Constructors

    constructor +ParsePublicKeyError | near-sdk-js - v2.0.0

    Class ParsePublicKeyError

    Hierarchy

    Constructors

    constructor

    Properties

    cause? message name diff --git a/classes/types_public_key.PublicKey.html b/classes/types_public_key.PublicKey.html index cb3de293..792370b1 100644 --- a/classes/types_public_key.PublicKey.html +++ b/classes/types_public_key.PublicKey.html @@ -1,12 +1,12 @@ PublicKey | near-sdk-js - v2.0.0

    Class PublicKey

    A abstraction on top of the NEAR public key string.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    data type

    Methods

    curveType fromString

    Constructors

    constructor

    Properties

    data

    data: Uint8Array

    The actual value of the public key.

    -

    Private type

    type: CurveType

    Methods

    curveType

    Static fromString

    • fromString(publicKeyString): PublicKey

    • Create a public key from a public key string.

      +

    Returns PublicKey

    Properties

    data

    data: Uint8Array

    The actual value of the public key.

    +

    Private type

    type: CurveType

    Methods

    curveType

    Static fromString

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns PublicKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/types_public_key.UnknownCurve.html b/classes/types_public_key.UnknownCurve.html index f7989501..7a7310e1 100644 --- a/classes/types_public_key.UnknownCurve.html +++ b/classes/types_public_key.UnknownCurve.html @@ -1,4 +1,4 @@ -UnknownCurve | near-sdk-js - v2.0.0

    Class UnknownCurve

    Hierarchy

    Constructors

    constructor +UnknownCurve | near-sdk-js - v2.0.0

    Class UnknownCurve

    Hierarchy

    Constructors

    constructor

    Properties

    cause? message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    Optional cause

    cause?: Error

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

      • (err, stackTraces): any

      • Optional override for formatting stack traces

        +

    Constructors

    constructor

    Properties

    Optional cause

    cause?: Error

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    Static stackTraceLimit

    stackTraceLimit: number

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/utils.TextDecoder.html b/classes/utils.TextDecoder.html index ee567e2d..c26fee4d 100644 --- a/classes/utils.TextDecoder.html +++ b/classes/utils.TextDecoder.html @@ -1,5 +1,5 @@ TextDecoder | near-sdk-js - v2.0.0

    Class TextDecoder

    A subset of NodeJS TextDecoder API. Only support utf-8 and latin1 encoding.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    encoding

    Methods

    decode -

    Constructors

    constructor

    Properties

    encoding

    encoding: string = "utf-8"

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    encoding

    encoding: string = "utf-8"

    Methods

    decode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/utils.TextEncoder.html b/classes/utils.TextEncoder.html index f347aa02..5c6da656 100644 --- a/classes/utils.TextEncoder.html +++ b/classes/utils.TextEncoder.html @@ -1,4 +1,4 @@ TextEncoder | near-sdk-js - v2.0.0

    Class TextEncoder

    A subset of NodeJS TextEncoder API

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    encode -

    Constructors

    constructor

    Methods

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Methods

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/types_public_key.CurveType.html b/enums/types_public_key.CurveType.html index b43e2aa1..b4bfcfc7 100644 --- a/enums/types_public_key.CurveType.html +++ b/enums/types_public_key.CurveType.html @@ -1,3 +1,3 @@ -CurveType | near-sdk-js - v2.0.0

    Enumeration CurveType

    Enumeration Members

    ED25519 +CurveType | near-sdk-js - v2.0.0

    Enumeration CurveType

    Enumeration Members

    ED25519 SECP256K1 -

    Enumeration Members

    ED25519

    ED25519: 0

    SECP256K1

    SECP256K1: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    ED25519

    ED25519: 0

    SECP256K1

    SECP256K1: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/types_vm_types.PromiseError.html b/enums/types_vm_types.PromiseError.html index 3273c668..44b6e545 100644 --- a/enums/types_vm_types.PromiseError.html +++ b/enums/types_vm_types.PromiseError.html @@ -1,4 +1,4 @@ PromiseError | near-sdk-js - v2.0.0

    Enumeration PromiseError

    A promise error can either be due to the promise failing or not yet being ready.

    -

    Enumeration Members

    Failed +

    Enumeration Members

    Failed NotReady -

    Enumeration Members

    Failed

    Failed: 0

    NotReady

    NotReady: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Failed

    Failed: 0

    NotReady

    NotReady: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/types_vm_types.PromiseResult.html b/enums/types_vm_types.PromiseResult.html index ce7c5af6..07f33e26 100644 --- a/enums/types_vm_types.PromiseResult.html +++ b/enums/types_vm_types.PromiseResult.html @@ -4,7 +4,7 @@
  • Successful = 1 - the promise has been successfully executed and you can retrieve the resulting value.
  • Failed = 2 - the promise execution has failed.
    • -

    Enumeration Members

    Failed +

    Enumeration Members

    Failed NotReady Successful -

    Enumeration Members

    Failed

    Failed: 2

    NotReady

    NotReady: 0

    Successful

    Successful: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    Failed

    Failed: 2

    NotReady

    NotReady: 0

    Successful

    Successful: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.accountBalance.html b/functions/api.accountBalance.html index 8d9038af..9fe85c98 100644 --- a/functions/api.accountBalance.html +++ b/functions/api.accountBalance.html @@ -1,2 +1,2 @@ accountBalance | near-sdk-js - v2.0.0

    Function accountBalance

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.accountLockedBalance.html b/functions/api.accountLockedBalance.html index f412472a..cbde96f1 100644 --- a/functions/api.accountLockedBalance.html +++ b/functions/api.accountLockedBalance.html @@ -1,2 +1,2 @@ accountLockedBalance | near-sdk-js - v2.0.0

    Function accountLockedBalance

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.altBn128G1Multiexp.html b/functions/api.altBn128G1Multiexp.html index cbf040d2..97b1350c 100644 --- a/functions/api.altBn128G1Multiexp.html +++ b/functions/api.altBn128G1Multiexp.html @@ -6,4 +6,4 @@ value is encoded as packed, little-endian [((u256, u256), u256)] slice.

    Returns Uint8Array

    multi exp sum

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.altBn128G1Sum.html b/functions/api.altBn128G1Sum.html index f00a8dbe..91fee82b 100644 --- a/functions/api.altBn128G1Sum.html +++ b/functions/api.altBn128G1Sum.html @@ -5,4 +5,4 @@ alt_bn128 is Y^2 = X^3 + 3 curve over Fq. valueis encoded a as packed, little-endian[((u256, u256), ((u256, u256), (u256, u256)))]` slice.

    Returns Uint8Array

    sum over Fq.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.altBn128PairingCheck.html b/functions/api.altBn128PairingCheck.html index 904febb9..26fe1bfd 100644 --- a/functions/api.altBn128PairingCheck.html +++ b/functions/api.altBn128PairingCheck.html @@ -9,4 +9,4 @@ value is encoded a as packed, little-endian [((u256, u256), ((u256, u256), (u256, u256)))] slice.

    Returns boolean

    whether pairing check pass

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.attachedDeposit.html b/functions/api.attachedDeposit.html index eb9d9367..93696c3c 100644 --- a/functions/api.attachedDeposit.html +++ b/functions/api.attachedDeposit.html @@ -1,3 +1,3 @@ attachedDeposit | near-sdk-js - v2.0.0

    Function attachedDeposit

    • attachedDeposit(): bigint

    • Returns the amount of NEAR attached to this function call. Can only be called in payable functions.

      -

      Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.blockHeight.html b/functions/api.blockHeight.html index 52124f07..11b4f981 100644 --- a/functions/api.blockHeight.html +++ b/functions/api.blockHeight.html @@ -1,2 +1,2 @@ blockHeight | near-sdk-js - v2.0.0

    Function blockHeight

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.blockIndex.html b/functions/api.blockIndex.html index 343a1aa7..92af7a0d 100644 --- a/functions/api.blockIndex.html +++ b/functions/api.blockIndex.html @@ -1,2 +1,2 @@ blockIndex | near-sdk-js - v2.0.0

    Function blockIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.blockTimestamp.html b/functions/api.blockTimestamp.html index 624878a4..626a37a1 100644 --- a/functions/api.blockTimestamp.html +++ b/functions/api.blockTimestamp.html @@ -1,2 +1,2 @@ blockTimestamp | near-sdk-js - v2.0.0

    Function blockTimestamp

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.currentAccountId.html b/functions/api.currentAccountId.html index b7d7d377..7b10543d 100644 --- a/functions/api.currentAccountId.html +++ b/functions/api.currentAccountId.html @@ -1,2 +1,2 @@ currentAccountId | near-sdk-js - v2.0.0

    Function currentAccountId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.ecrecover.html b/functions/api.ecrecover.html index 746b146e..61985211 100644 --- a/functions/api.ecrecover.html +++ b/functions/api.ecrecover.html @@ -6,4 +6,4 @@
  • v: number

    number of recovery byte

  • malleabilityFlag: number

    whether to check malleability

    • Returns Uint8Array | null

    64 bytes representing the public key if the recovery was successful.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.epochHeight.html b/functions/api.epochHeight.html index 843d7c8b..b8da5687 100644 --- a/functions/api.epochHeight.html +++ b/functions/api.epochHeight.html @@ -1,2 +1,2 @@ epochHeight | near-sdk-js - v2.0.0

    Function epochHeight

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.input.html b/functions/api.input.html index be2a6795..610a62ed 100644 --- a/functions/api.input.html +++ b/functions/api.input.html @@ -1,2 +1,2 @@ input | near-sdk-js - v2.0.0

    Function input

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.inputRaw.html b/functions/api.inputRaw.html index 4975dcf7..8ec35943 100644 --- a/functions/api.inputRaw.html +++ b/functions/api.inputRaw.html @@ -1,2 +1,2 @@ inputRaw | near-sdk-js - v2.0.0

    Function inputRaw

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.keccak256.html b/functions/api.keccak256.html index 04fad8e0..6da8a3cb 100644 --- a/functions/api.keccak256.html +++ b/functions/api.keccak256.html @@ -1,4 +1,4 @@ keccak256 | near-sdk-js - v2.0.0

    Function keccak256

    • keccak256(value): Uint8Array

    • Returns keccak256 hash of given value

      Parameters

      • value: Uint8Array

        value to be hashed, in Bytes

      Returns Uint8Array

      hash result in Bytes

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.keccak512.html b/functions/api.keccak512.html index cd40b793..8dbe4f7c 100644 --- a/functions/api.keccak512.html +++ b/functions/api.keccak512.html @@ -1,4 +1,4 @@ keccak512 | near-sdk-js - v2.0.0

    Function keccak512

    • keccak512(value): Uint8Array

    • Returns keccak512 hash of given value

      Parameters

      • value: Uint8Array

        value to be hashed, in Bytes

      Returns Uint8Array

      hash result in Bytes

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.log.html b/functions/api.log.html index 70b9fb50..7cd2aa52 100644 --- a/functions/api.log.html +++ b/functions/api.log.html @@ -1,3 +1,3 @@ log | near-sdk-js - v2.0.0

    Function log

    • log(...params): void

    • Logs parameters in the NEAR WASM virtual machine.

      Parameters

      • Rest ...params: unknown[]

        Parameters to log.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.logUtf16.html b/functions/api.logUtf16.html index 96cd5d8c..6f7c09a6 100644 --- a/functions/api.logUtf16.html +++ b/functions/api.logUtf16.html @@ -1,3 +1,3 @@ logUtf16 | near-sdk-js - v2.0.0

    Function logUtf16

    • logUtf16(msg): void

    • Log the message in transaction logs

      Parameters

      • msg: Uint8Array

        message in raw bytes, which should be a valid UTF-16 sequence

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.logUtf8.html b/functions/api.logUtf8.html index 4bc08deb..8429384c 100644 --- a/functions/api.logUtf8.html +++ b/functions/api.logUtf8.html @@ -1,3 +1,3 @@ logUtf8 | near-sdk-js - v2.0.0

    Function logUtf8

    • logUtf8(msg): void

    • Log the message in transaction logs

      Parameters

      • msg: Uint8Array

        message in raw bytes, which should be a valid UTF-8 sequence

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.panicUtf8.html b/functions/api.panicUtf8.html index 1da65649..71307f02 100644 --- a/functions/api.panicUtf8.html +++ b/functions/api.panicUtf8.html @@ -1,3 +1,3 @@ panicUtf8 | near-sdk-js - v2.0.0

    Function panicUtf8

    • panicUtf8(msg): never

    • Panic the transaction execution with given message

      Parameters

      • msg: Uint8Array

        panic message in raw bytes, which should be a valid UTF-8 sequence

        -

      Returns never

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns never

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.predecessorAccountId.html b/functions/api.predecessorAccountId.html index c30df9e4..c15f6329 100644 --- a/functions/api.predecessorAccountId.html +++ b/functions/api.predecessorAccountId.html @@ -1,3 +1,3 @@ predecessorAccountId | near-sdk-js - v2.0.0

    Function predecessorAccountId

    • predecessorAccountId(): string

    • Returns the account ID of the account that called the function. Can only be called in a call or initialize function.

      -

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.prepaidGas.html b/functions/api.prepaidGas.html index a4769b16..cf1464d6 100644 --- a/functions/api.prepaidGas.html +++ b/functions/api.prepaidGas.html @@ -1,2 +1,2 @@ prepaidGas | near-sdk-js - v2.0.0

    Function prepaidGas

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseAnd.html b/functions/api.promiseAnd.html index d9aba6ed..88ecd8af 100644 --- a/functions/api.promiseAnd.html +++ b/functions/api.promiseAnd.html @@ -1,3 +1,3 @@ promiseAnd | near-sdk-js - v2.0.0

    Function promiseAnd

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionAddKeyWithFullAccess.html b/functions/api.promiseBatchActionAddKeyWithFullAccess.html index a8ab278c..85d14436 100644 --- a/functions/api.promiseBatchActionAddKeyWithFullAccess.html +++ b/functions/api.promiseBatchActionAddKeyWithFullAccess.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionAddKeyWithFunctionCall.html b/functions/api.promiseBatchActionAddKeyWithFunctionCall.html index 8da8c3b5..d75c45fe 100644 --- a/functions/api.promiseBatchActionAddKeyWithFunctionCall.html +++ b/functions/api.promiseBatchActionAddKeyWithFunctionCall.html @@ -5,4 +5,4 @@
  • allowance: NearAmount

    The allowance of the access key.

  • receiverId: string

    The account ID of the receiver.

  • methodNames: string

    The names of the method to allow the key for.

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionCreateAccount.html b/functions/api.promiseBatchActionCreateAccount.html index 0cea094f..1ac84cb0 100644 --- a/functions/api.promiseBatchActionCreateAccount.html +++ b/functions/api.promiseBatchActionCreateAccount.html @@ -1,3 +1,3 @@ promiseBatchActionCreateAccount | near-sdk-js - v2.0.0

    Function promiseBatchActionCreateAccount

    • promiseBatchActionCreateAccount(promiseIndex): void

    • Attach a create account promise action to the NEAR promise index with the provided promise index.

      Parameters

      • promiseIndex: PromiseIndex

        The index of the promise to attach a create account action to.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionDeleteAccount.html b/functions/api.promiseBatchActionDeleteAccount.html index 921d237e..37a2767f 100644 --- a/functions/api.promiseBatchActionDeleteAccount.html +++ b/functions/api.promiseBatchActionDeleteAccount.html @@ -1,4 +1,4 @@ promiseBatchActionDeleteAccount | near-sdk-js - v2.0.0

    Function promiseBatchActionDeleteAccount

    • promiseBatchActionDeleteAccount(promiseIndex, beneficiaryId): void

    • Attach a delete account promise action to the NEAR promise index with the provided promise index.

      Parameters

      • promiseIndex: PromiseIndex

        The index of the promise to attach a delete account action to.

      • beneficiaryId: string

        The account ID of the beneficiary - the account that receives the remaining amount of NEAR.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionDeleteKey.html b/functions/api.promiseBatchActionDeleteKey.html index ede67e55..67982327 100644 --- a/functions/api.promiseBatchActionDeleteKey.html +++ b/functions/api.promiseBatchActionDeleteKey.html @@ -1,4 +1,4 @@ promiseBatchActionDeleteKey | near-sdk-js - v2.0.0

    Function promiseBatchActionDeleteKey

    • promiseBatchActionDeleteKey(promiseIndex, publicKey): void

    • Attach a delete key promise action to the NEAR promise index with the provided promise index.

      Parameters

      • promiseIndex: PromiseIndex

        The index of the promise to attach a delete key action to.

      • publicKey: Uint8Array

        The public key to delete.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionDeployContract.html b/functions/api.promiseBatchActionDeployContract.html index d8335d1e..b072f902 100644 --- a/functions/api.promiseBatchActionDeployContract.html +++ b/functions/api.promiseBatchActionDeployContract.html @@ -1,4 +1,4 @@ promiseBatchActionDeployContract | near-sdk-js - v2.0.0

    Function promiseBatchActionDeployContract

    • promiseBatchActionDeployContract(promiseIndex, code): void

    • Attach a deploy contract promise action to the NEAR promise index with the provided promise index.

      Parameters

      • promiseIndex: PromiseIndex

        The index of the promise to attach a deploy contract action to.

      • code: Uint8Array

        The WASM byte code of the contract to be deployed.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionFunctionCall.html b/functions/api.promiseBatchActionFunctionCall.html index cd295a98..89010dec 100644 --- a/functions/api.promiseBatchActionFunctionCall.html +++ b/functions/api.promiseBatchActionFunctionCall.html @@ -4,4 +4,4 @@
  • args: string

    The utf-8 string arguments to call the method with.

  • amount: NearAmount

    The amount of NEAR to attach to the call.

  • gas: NearAmount

    The amount of Gas to attach to the call.

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionFunctionCallRaw.html b/functions/api.promiseBatchActionFunctionCallRaw.html index 11cff352..247cb651 100644 --- a/functions/api.promiseBatchActionFunctionCallRaw.html +++ b/functions/api.promiseBatchActionFunctionCallRaw.html @@ -4,4 +4,4 @@
  • args: Uint8Array

    The arguments to call the method with.

  • amount: NearAmount

    The amount of NEAR to attach to the call.

  • gas: NearAmount

    The amount of Gas to attach to the call.

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionFunctionCallWeight.html b/functions/api.promiseBatchActionFunctionCallWeight.html index 59490124..b60bb9a9 100644 --- a/functions/api.promiseBatchActionFunctionCallWeight.html +++ b/functions/api.promiseBatchActionFunctionCallWeight.html @@ -5,4 +5,4 @@
  • amount: NearAmount

    The amount of NEAR to attach to the call.

  • gas: NearAmount

    The amount of Gas to attach to the call.

  • weight: bigint

    The weight of unused Gas to use.

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionFunctionCallWeightRaw.html b/functions/api.promiseBatchActionFunctionCallWeightRaw.html index 4193ca99..8ccbbdf7 100644 --- a/functions/api.promiseBatchActionFunctionCallWeightRaw.html +++ b/functions/api.promiseBatchActionFunctionCallWeightRaw.html @@ -5,4 +5,4 @@
  • amount: NearAmount

    The amount of NEAR to attach to the call.

  • gas: NearAmount

    The amount of Gas to attach to the call.

  • weight: bigint

    The weight of unused Gas to use.

    -

    • Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionStake.html b/functions/api.promiseBatchActionStake.html index 9ff4fa3a..06b7c39b 100644 --- a/functions/api.promiseBatchActionStake.html +++ b/functions/api.promiseBatchActionStake.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchActionTransfer.html b/functions/api.promiseBatchActionTransfer.html index 2db886f1..fb7d1e50 100644 --- a/functions/api.promiseBatchActionTransfer.html +++ b/functions/api.promiseBatchActionTransfer.html @@ -1,4 +1,4 @@ promiseBatchActionTransfer | near-sdk-js - v2.0.0

    Function promiseBatchActionTransfer

    • promiseBatchActionTransfer(promiseIndex, amount): void

    • Attach a transfer promise action to the NEAR promise index with the provided promise index.

      Parameters

      • promiseIndex: PromiseIndex

        The index of the promise to attach a transfer action to.

      • amount: NearAmount

        The amount of NEAR to transfer.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchCreate.html b/functions/api.promiseBatchCreate.html index fece890e..585ae6da 100644 --- a/functions/api.promiseBatchCreate.html +++ b/functions/api.promiseBatchCreate.html @@ -1,3 +1,3 @@ promiseBatchCreate | near-sdk-js - v2.0.0

    Function promiseBatchCreate

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseBatchThen.html b/functions/api.promiseBatchThen.html index 8e4c7ba2..46f91bcc 100644 --- a/functions/api.promiseBatchThen.html +++ b/functions/api.promiseBatchThen.html @@ -1,4 +1,4 @@ promiseBatchThen | near-sdk-js - v2.0.0

    Function promiseBatchThen

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseCreate.html b/functions/api.promiseCreate.html index dc8f4eb5..0db79378 100644 --- a/functions/api.promiseCreate.html +++ b/functions/api.promiseCreate.html @@ -4,4 +4,4 @@
  • args: string

    The utf-8 string arguments to call the method with.

  • amount: NearAmount

    The amount of NEAR attached to the call.

  • gas: NearAmount

    The amount of Gas attached to the call.

    -

    • Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseCreateRaw.html b/functions/api.promiseCreateRaw.html index 35e33947..94ab1021 100644 --- a/functions/api.promiseCreateRaw.html +++ b/functions/api.promiseCreateRaw.html @@ -4,4 +4,4 @@
  • args: Uint8Array

    The arguments to call the method with.

  • amount: NearAmount

    The amount of NEAR attached to the call.

  • gas: NearAmount

    The amount of Gas attached to the call.

    -

    • Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseResult.html b/functions/api.promiseResult.html index 6330b154..1f9cae8f 100644 --- a/functions/api.promiseResult.html +++ b/functions/api.promiseResult.html @@ -1,3 +1,3 @@ promiseResult | near-sdk-js - v2.0.0

    Function promiseResult

    • promiseResult(promiseIndex): string

    • Returns the result of the NEAR promise for the passed promise index as utf-8 string

      Parameters

      • promiseIndex: PromiseIndex

        The index of the promise to return the result for.

        -

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseResultRaw.html b/functions/api.promiseResultRaw.html index 058750df..b2692ebf 100644 --- a/functions/api.promiseResultRaw.html +++ b/functions/api.promiseResultRaw.html @@ -1,3 +1,3 @@ promiseResultRaw | near-sdk-js - v2.0.0

    Function promiseResultRaw

    • promiseResultRaw(promiseIndex): Uint8Array

    • Returns the result of the NEAR promise for the passed promise index.

      Parameters

      • promiseIndex: PromiseIndex

        The index of the promise to return the result for.

        -

      Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseResultsCount.html b/functions/api.promiseResultsCount.html index c62755e2..eb708e68 100644 --- a/functions/api.promiseResultsCount.html +++ b/functions/api.promiseResultsCount.html @@ -1,2 +1,2 @@ promiseResultsCount | near-sdk-js - v2.0.0

    Function promiseResultsCount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseReturn.html b/functions/api.promiseReturn.html index ee22aaa3..99d38e04 100644 --- a/functions/api.promiseReturn.html +++ b/functions/api.promiseReturn.html @@ -1,3 +1,3 @@ promiseReturn | near-sdk-js - v2.0.0

    Function promiseReturn

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseThen.html b/functions/api.promiseThen.html index 77817644..a06f16e7 100644 --- a/functions/api.promiseThen.html +++ b/functions/api.promiseThen.html @@ -5,4 +5,4 @@
  • args: string

    The utf-8 string arguments to call the method with.

  • amount: NearAmount

    The amount of NEAR to attach to the call.

  • gas: NearAmount

    The amount of Gas to attach to the call.

    -

    • Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.promiseThenRaw.html b/functions/api.promiseThenRaw.html index c7597e86..8dd9bf8e 100644 --- a/functions/api.promiseThenRaw.html +++ b/functions/api.promiseThenRaw.html @@ -5,4 +5,4 @@
  • args: Uint8Array

    The arguments to call the method with.

  • amount: NearAmount

    The amount of NEAR to attach to the call.

  • gas: NearAmount

    The amount of Gas to attach to the call.

    -

    • Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns PromiseIndex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.randomSeed.html b/functions/api.randomSeed.html index 7b8d9ae8..b27b1f8e 100644 --- a/functions/api.randomSeed.html +++ b/functions/api.randomSeed.html @@ -1,2 +1,2 @@ randomSeed | near-sdk-js - v2.0.0

    Function randomSeed

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.ripemd160.html b/functions/api.ripemd160.html index e2bd8119..cd0d2ece 100644 --- a/functions/api.ripemd160.html +++ b/functions/api.ripemd160.html @@ -1,4 +1,4 @@ ripemd160 | near-sdk-js - v2.0.0

    Function ripemd160

    • ripemd160(value): Uint8Array

    • Returns ripemd160 hash of given value

      Parameters

      • value: Uint8Array

        value to be hashed, in Bytes

      Returns Uint8Array

      hash result in Bytes

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.sha256.html b/functions/api.sha256.html index a937e645..57680e6b 100644 --- a/functions/api.sha256.html +++ b/functions/api.sha256.html @@ -1,4 +1,4 @@ sha256 | near-sdk-js - v2.0.0

    Function sha256

    • sha256(value): Uint8Array

    • Returns sha256 hash of given value

      Parameters

      • value: Uint8Array

        value to be hashed, in Bytes

      Returns Uint8Array

      hash result in Bytes

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.signerAccountId.html b/functions/api.signerAccountId.html index 95cd7d7c..7d5b3dde 100644 --- a/functions/api.signerAccountId.html +++ b/functions/api.signerAccountId.html @@ -1,3 +1,3 @@ signerAccountId | near-sdk-js - v2.0.0

    Function signerAccountId

    • signerAccountId(): string

    • Returns the account ID of the account that signed the transaction. Can only be called in a call or initialize function.

      -

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.signerAccountPk.html b/functions/api.signerAccountPk.html index 36ae6577..842e3103 100644 --- a/functions/api.signerAccountPk.html +++ b/functions/api.signerAccountPk.html @@ -1,3 +1,3 @@ signerAccountPk | near-sdk-js - v2.0.0

    Function signerAccountPk

    • signerAccountPk(): Uint8Array

    • Returns the public key of the account that signed the transaction. Can only be called in a call or initialize function.

      -

      Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageByteCost.html b/functions/api.storageByteCost.html index d1f33611..49f26d54 100644 --- a/functions/api.storageByteCost.html +++ b/functions/api.storageByteCost.html @@ -1,2 +1,2 @@ storageByteCost | near-sdk-js - v2.0.0

    Function storageByteCost

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageGetEvicted.html b/functions/api.storageGetEvicted.html index 79bd9a47..11fd6342 100644 --- a/functions/api.storageGetEvicted.html +++ b/functions/api.storageGetEvicted.html @@ -1,2 +1,2 @@ storageGetEvicted | near-sdk-js - v2.0.0

    Function storageGetEvicted

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageGetEvictedRaw.html b/functions/api.storageGetEvictedRaw.html index 9af688a4..6e70c931 100644 --- a/functions/api.storageGetEvictedRaw.html +++ b/functions/api.storageGetEvictedRaw.html @@ -1,2 +1,2 @@ storageGetEvictedRaw | near-sdk-js - v2.0.0

    Function storageGetEvictedRaw

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageHasKey.html b/functions/api.storageHasKey.html index ec7e76c9..62954573 100644 --- a/functions/api.storageHasKey.html +++ b/functions/api.storageHasKey.html @@ -1,3 +1,3 @@ storageHasKey | near-sdk-js - v2.0.0

    Function storageHasKey

    • storageHasKey(key): boolean

    • Checks for the existance of a value under the provided utf-8 string key in NEAR storage.

      Parameters

      • key: string

        The utf-8 string key to check for in storage.

        -

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageHasKeyRaw.html b/functions/api.storageHasKeyRaw.html index 48387d8e..1e1a24db 100644 --- a/functions/api.storageHasKeyRaw.html +++ b/functions/api.storageHasKeyRaw.html @@ -1,3 +1,3 @@ storageHasKeyRaw | near-sdk-js - v2.0.0

    Function storageHasKeyRaw

    • storageHasKeyRaw(key): boolean

    • Checks for the existance of a value under the provided key in NEAR storage.

      Parameters

      • key: Uint8Array

        The key to check for in storage.

        -

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageRead.html b/functions/api.storageRead.html index d3400375..57933999 100644 --- a/functions/api.storageRead.html +++ b/functions/api.storageRead.html @@ -1,3 +1,3 @@ storageRead | near-sdk-js - v2.0.0

    Function storageRead

    • storageRead(key): string | null

    • Reads the utf-8 string value from NEAR storage that is stored under the provided key.

      Parameters

      • key: string

        The utf-8 string key to read from storage.

        -

      Returns string | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageReadRaw.html b/functions/api.storageReadRaw.html index 1c7c9fc1..cab2128f 100644 --- a/functions/api.storageReadRaw.html +++ b/functions/api.storageReadRaw.html @@ -1,3 +1,3 @@ storageReadRaw | near-sdk-js - v2.0.0

    Function storageReadRaw

    • storageReadRaw(key): Uint8Array | null

    • Reads the value from NEAR storage that is stored under the provided key.

      Parameters

      • key: Uint8Array

        The key to read from storage.

        -

      Returns Uint8Array | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Uint8Array | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageRemove.html b/functions/api.storageRemove.html index 56315799..2fb7fa29 100644 --- a/functions/api.storageRemove.html +++ b/functions/api.storageRemove.html @@ -1,3 +1,3 @@ storageRemove | near-sdk-js - v2.0.0

    Function storageRemove

    • storageRemove(key): boolean

    • Removes the value of the provided utf-8 string key from NEAR storage.

      Parameters

      • key: string

        The utf-8 string key to be removed.

        -

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageRemoveRaw.html b/functions/api.storageRemoveRaw.html index bb5ab91d..47bc84fc 100644 --- a/functions/api.storageRemoveRaw.html +++ b/functions/api.storageRemoveRaw.html @@ -1,3 +1,3 @@ storageRemoveRaw | near-sdk-js - v2.0.0

    Function storageRemoveRaw

    • storageRemoveRaw(key): boolean

    • Removes the value of the provided key from NEAR storage.

      Parameters

      • key: Uint8Array

        The key to be removed.

        -

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageUsage.html b/functions/api.storageUsage.html index 32f572f6..df8cd637 100644 --- a/functions/api.storageUsage.html +++ b/functions/api.storageUsage.html @@ -1,2 +1,2 @@ storageUsage | near-sdk-js - v2.0.0

    Function storageUsage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageWrite.html b/functions/api.storageWrite.html index 9c511de3..8acb19f4 100644 --- a/functions/api.storageWrite.html +++ b/functions/api.storageWrite.html @@ -1,4 +1,4 @@ storageWrite | near-sdk-js - v2.0.0

    Function storageWrite

    • storageWrite(key, value): boolean

    • Writes the provided utf-8 string to NEAR storage under the provided key.

      Parameters

      • key: string

        The utf-8 string key under which to store the value.

      • value: string

        The utf-8 string value to store.

        -

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.storageWriteRaw.html b/functions/api.storageWriteRaw.html index 23484560..0bc8ffe2 100644 --- a/functions/api.storageWriteRaw.html +++ b/functions/api.storageWriteRaw.html @@ -1,4 +1,4 @@ storageWriteRaw | near-sdk-js - v2.0.0

    Function storageWriteRaw

    • storageWriteRaw(key, value): boolean

    • Writes the provided bytes to NEAR storage under the provided key.

      Parameters

      • key: Uint8Array

        The key under which to store the value.

      • value: Uint8Array

        The value to store.

        -

      Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.usedGas.html b/functions/api.usedGas.html index 617284de..3c8774fa 100644 --- a/functions/api.usedGas.html +++ b/functions/api.usedGas.html @@ -1,2 +1,2 @@ usedGas | near-sdk-js - v2.0.0

    Function usedGas

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns bigint

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.validatorStake.html b/functions/api.validatorStake.html index 0d1e18c6..87633528 100644 --- a/functions/api.validatorStake.html +++ b/functions/api.validatorStake.html @@ -3,4 +3,4 @@

    Returns bigint

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.validatorTotalStake.html b/functions/api.validatorTotalStake.html index d514a196..303865a5 100644 --- a/functions/api.validatorTotalStake.html +++ b/functions/api.validatorTotalStake.html @@ -1,3 +1,3 @@ validatorTotalStake | near-sdk-js - v2.0.0

    Function validatorTotalStake

    • validatorTotalStake(): bigint

    • Returns the number of staked NEAR of all validators, in yoctoNEAR

      Returns bigint

      total staked amount

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.valueReturn.html b/functions/api.valueReturn.html index 3f375ad8..9c2757ad 100644 --- a/functions/api.valueReturn.html +++ b/functions/api.valueReturn.html @@ -1,3 +1,3 @@ valueReturn | near-sdk-js - v2.0.0

    Function valueReturn

    • valueReturn(value): void

    • Returns the utf-8 string value from the NEAR WASM virtual machine.

      Parameters

      • value: string

        The utf-8 string value to return.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/api.valueReturnRaw.html b/functions/api.valueReturnRaw.html index 82b99c72..f1e759ee 100644 --- a/functions/api.valueReturnRaw.html +++ b/functions/api.valueReturnRaw.html @@ -1,3 +1,3 @@ valueReturnRaw | near-sdk-js - v2.0.0

    Function valueReturnRaw

    • valueReturnRaw(value): void

    • Returns the value from the NEAR WASM virtual machine.

      Parameters

      • value: Uint8Array

        The value to return.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_abi.runAbiCompilerPlugin.html b/functions/cli_abi.runAbiCompilerPlugin.html index 0e92898a..4bde622a 100644 --- a/functions/cli_abi.runAbiCompilerPlugin.html +++ b/functions/cli_abi.runAbiCompilerPlugin.html @@ -1 +1 @@ -runAbiCompilerPlugin | near-sdk-js - v2.0.0

    Function runAbiCompilerPlugin

    • runAbiCompilerPlugin(tsFile, packageJsonPath, tsConfigJsonPath): AbiRoot

    • Parameters

      • tsFile: string
      • packageJsonPath: string
      • tsConfigJsonPath: string

      Returns AbiRoot

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +runAbiCompilerPlugin | near-sdk-js - v2.0.0

    Function runAbiCompilerPlugin

    • runAbiCompilerPlugin(tsFile, packageJsonPath, tsConfigJsonPath): AbiRoot

    • Parameters

      • tsFile: string
      • packageJsonPath: string
      • tsConfigJsonPath: string

      Returns AbiRoot

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_build_tools_include_bytes.default.html b/functions/cli_build_tools_include_bytes.default.html index aed802ce..76811299 100644 --- a/functions/cli_build_tools_include_bytes.default.html +++ b/functions/cli_build_tools_include_bytes.default.html @@ -1 +1 @@ -default | near-sdk-js - v2.0.0

    Function default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +default | near-sdk-js - v2.0.0

    Function default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_build_tools_near_bindgen_exporter.default.html b/functions/cli_build_tools_near_bindgen_exporter.default.html index 15f58f99..08093498 100644 --- a/functions/cli_build_tools_near_bindgen_exporter.default.html +++ b/functions/cli_build_tools_near_bindgen_exporter.default.html @@ -1 +1 @@ -default | near-sdk-js - v2.0.0

    Function default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +default | near-sdk-js - v2.0.0

    Function default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_cli.buildCom.html b/functions/cli_cli.buildCom.html index e9f1a7a1..dc8ed719 100644 --- a/functions/cli_cli.buildCom.html +++ b/functions/cli_cli.buildCom.html @@ -1 +1 @@ -buildCom | near-sdk-js - v2.0.0

    Function buildCom

    • buildCom(source, target, packageJson, tsConfig, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • target: string
      • packageJson: string
      • tsConfig: string
      • __namedParameters: {
            generateABI: boolean;
            verbose: boolean;
        }
        • generateABI: boolean
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +buildCom | near-sdk-js - v2.0.0

    Function buildCom

    • buildCom(source, target, packageJson, tsConfig, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • target: string
      • packageJson: string
      • tsConfig: string
      • __namedParameters: {
            generateABI: boolean;
            verbose: boolean;
        }
        • generateABI: boolean
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_cli.checkTypescriptCom.html b/functions/cli_cli.checkTypescriptCom.html index ca0e02a7..1a0cfaa6 100644 --- a/functions/cli_cli.checkTypescriptCom.html +++ b/functions/cli_cli.checkTypescriptCom.html @@ -1 +1 @@ -checkTypescriptCom | near-sdk-js - v2.0.0

    Function checkTypescriptCom

    • checkTypescriptCom(source, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +checkTypescriptCom | near-sdk-js - v2.0.0

    Function checkTypescriptCom

    • checkTypescriptCom(source, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_cli.createJsFileWithRollupCom.html b/functions/cli_cli.createJsFileWithRollupCom.html index f6ef2821..689ac970 100644 --- a/functions/cli_cli.createJsFileWithRollupCom.html +++ b/functions/cli_cli.createJsFileWithRollupCom.html @@ -1 +1 @@ -createJsFileWithRollupCom | near-sdk-js - v2.0.0

    Function createJsFileWithRollupCom

    • createJsFileWithRollupCom(source, target, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • target: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +createJsFileWithRollupCom | near-sdk-js - v2.0.0

    Function createJsFileWithRollupCom

    • createJsFileWithRollupCom(source, target, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • target: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_cli.generateAbi.html b/functions/cli_cli.generateAbi.html index 9fd34600..db9b4bb5 100644 --- a/functions/cli_cli.generateAbi.html +++ b/functions/cli_cli.generateAbi.html @@ -1 +1 @@ -generateAbi | near-sdk-js - v2.0.0

    Function generateAbi

    • generateAbi(source, target, packageJson, tsConfig, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • target: string
      • packageJson: string
      • tsConfig: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +generateAbi | near-sdk-js - v2.0.0

    Function generateAbi

    • generateAbi(source, target, packageJson, tsConfig, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • target: string
      • packageJson: string
      • tsConfig: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_cli.transpileJsAndBuildWasmCom.html b/functions/cli_cli.transpileJsAndBuildWasmCom.html index cbfe8da3..1191855c 100644 --- a/functions/cli_cli.transpileJsAndBuildWasmCom.html +++ b/functions/cli_cli.transpileJsAndBuildWasmCom.html @@ -1 +1 @@ -transpileJsAndBuildWasmCom | near-sdk-js - v2.0.0

    Function transpileJsAndBuildWasmCom

    • transpileJsAndBuildWasmCom(target, __namedParameters): Promise<void>

    • Parameters

      • target: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +transpileJsAndBuildWasmCom | near-sdk-js - v2.0.0

    Function transpileJsAndBuildWasmCom

    • transpileJsAndBuildWasmCom(target, __namedParameters): Promise<void>

    • Parameters

      • target: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_cli.validateCom.html b/functions/cli_cli.validateCom.html index e96dec1c..c9cd2a79 100644 --- a/functions/cli_cli.validateCom.html +++ b/functions/cli_cli.validateCom.html @@ -1 +1 @@ -validateCom | near-sdk-js - v2.0.0

    Function validateCom

    • validateCom(source, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +validateCom | near-sdk-js - v2.0.0

    Function validateCom

    • validateCom(source, __namedParameters): Promise<void>

    • Parameters

      • source: string
      • __namedParameters: {
            verbose: boolean;
        }
        • verbose: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_utils.download.html b/functions/cli_utils.download.html index da87a1b9..dc4d1f5c 100644 --- a/functions/cli_utils.download.html +++ b/functions/cli_utils.download.html @@ -1 +1 @@ -download | near-sdk-js - v2.0.0

    Function download

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +download | near-sdk-js - v2.0.0

    Function download

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_utils.executeCommand.html b/functions/cli_utils.executeCommand.html index 46b009d1..610756f1 100644 --- a/functions/cli_utils.executeCommand.html +++ b/functions/cli_utils.executeCommand.html @@ -1 +1 @@ -executeCommand | near-sdk-js - v2.0.0

    Function executeCommand

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +executeCommand | near-sdk-js - v2.0.0

    Function executeCommand

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cli_utils.validateContract.html b/functions/cli_utils.validateContract.html index 03ec92db..1663e5dd 100644 --- a/functions/cli_utils.validateContract.html +++ b/functions/cli_utils.validateContract.html @@ -1,4 +1,4 @@ validateContract | near-sdk-js - v2.0.0

    Function validateContract

    • validateContract(contractPath, verbose?): Promise<boolean>

    • Validates the contract by checking that all parameters are initialized in the constructor. Works only for contracts written in TypeScript.

      Parameters

      • contractPath: string

        Path to the contract.

      • verbose: boolean = false

        Whether to print verbose output.

        -

      Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.includeBytes.html b/functions/index.includeBytes.html index e4f6059b..cc29a5b2 100644 --- a/functions/index.includeBytes.html +++ b/functions/index.includeBytes.html @@ -1,3 +1,3 @@ includeBytes | near-sdk-js - v2.0.0

    Function includeBytes

    • includeBytes(pathToWasm): Uint8Array

    • A macro that reads the WASM code from the specified path at compile time.

      Parameters

      • pathToWasm: string

        The path to the WASM file to read code from.

        -

      Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/near_bindgen.NearBindgen.html b/functions/near_bindgen.NearBindgen.html index 051c1744..92343b14 100644 --- a/functions/near_bindgen.NearBindgen.html +++ b/functions/near_bindgen.NearBindgen.html @@ -4,5 +4,5 @@

    Parameters

    Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns unknown

  • serializer?:function

    • Returns any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/near_bindgen.call.html b/functions/near_bindgen.call.html index 1a7bead4..05eb77af 100644 --- a/functions/near_bindgen.call.html +++ b/functions/near_bindgen.call.html @@ -3,4 +3,4 @@

    Parameters

    Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/near_bindgen.initialize.html b/functions/near_bindgen.initialize.html index 2cd646ee..d6f892dc 100644 --- a/functions/near_bindgen.initialize.html +++ b/functions/near_bindgen.initialize.html @@ -1,3 +1,3 @@ initialize | near-sdk-js - v2.0.0

    Function initialize

    • initialize(_empty): DecoratorFunction

    • Tells the SDK to use this function as the initialization function of the contract.

      Parameters

      • _empty: EmptyParameterObject

        An empty object.

        -

      Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/near_bindgen.middleware.html b/functions/near_bindgen.middleware.html index e60a3f39..5805099f 100644 --- a/functions/near_bindgen.middleware.html +++ b/functions/near_bindgen.middleware.html @@ -1,3 +1,3 @@ middleware | near-sdk-js - v2.0.0

    Function middleware

    • middleware<Arguments>(...middlewares): DecoratorFunction

    • Tells the SDK to apply an array of passed in middleware to the function execution.

      Type Parameters

      • Arguments extends any[]

      Parameters

      • Rest ...middlewares: Middleware<Arguments>[]

        The middlewares to be executed.

        -

      Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/near_bindgen.migrate.html b/functions/near_bindgen.migrate.html index 0e0fd1ae..8cb91472 100644 --- a/functions/near_bindgen.migrate.html +++ b/functions/near_bindgen.migrate.html @@ -1,4 +1,4 @@ migrate | near-sdk-js - v2.0.0

    Function migrate

    • migrate(_empty): DecoratorFunction

    • Tells the SDK to use this function as the migration function of the contract. The migration function will ignore te existing state.

      Parameters

      • _empty: EmptyParameterObject

        An empty object.

        -

      Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/near_bindgen.view.html b/functions/near_bindgen.view.html index 3ff80ce6..f54863d4 100644 --- a/functions/near_bindgen.view.html +++ b/functions/near_bindgen.view.html @@ -1,3 +1,3 @@ view | near-sdk-js - v2.0.0

    Function view

    • view(_empty): DecoratorFunction

    • Tells the SDK to expose this function as a view function.

      Parameters

      • _empty: EmptyParameterObject

        An empty object.

        -

      Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns DecoratorFunction

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/types_public_key.curveTypeFromStr.html b/functions/types_public_key.curveTypeFromStr.html index 358e8547..c9f77daa 100644 --- a/functions/types_public_key.curveTypeFromStr.html +++ b/functions/types_public_key.curveTypeFromStr.html @@ -1 +1 @@ -curveTypeFromStr | near-sdk-js - v2.0.0

    Function curveTypeFromStr

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +curveTypeFromStr | near-sdk-js - v2.0.0

    Function curveTypeFromStr

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.assert.html b/functions/utils.assert.html index 6165e328..92952390 100644 --- a/functions/utils.assert.html +++ b/functions/utils.assert.html @@ -1,4 +1,4 @@ assert | near-sdk-js - v2.0.0

    Function assert

    • assert(expression, message): asserts expression

    • Asserts that the expression passed to the function is truthy, otherwise throws a new Error with the provided message.

      Parameters

      • expression: unknown

        The expression to be asserted.

      • message: string

        The error message to be printed.

        -

      Returns asserts expression

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns asserts expression

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.bytes.html b/functions/utils.bytes.html index 56829c7e..74236ef4 100644 --- a/functions/utils.bytes.html +++ b/functions/utils.bytes.html @@ -1,4 +1,4 @@ bytes | near-sdk-js - v2.0.0

    Function bytes

    • bytes(s): Uint8Array

    • Convert a string to Uint8Array, each character must have a char code between 0-255.

      Parameters

      • s: string

        string that with only Latin1 character to convert

      Returns Uint8Array

      result Uint8Array

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.concat.html b/functions/utils.concat.html index 789c2e7a..9657b32a 100644 --- a/functions/utils.concat.html +++ b/functions/utils.concat.html @@ -1,3 +1,3 @@ concat | near-sdk-js - v2.0.0

    Function concat

    • concat(array1, array2): Uint8Array

    • Concat two Uint8Array

      Parameters

      • array1: Uint8Array
      • array2: Uint8Array

      Returns Uint8Array

      the concatenation of two array

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.decode.html b/functions/utils.decode.html index 04573ae5..45e4a753 100644 --- a/functions/utils.decode.html +++ b/functions/utils.decode.html @@ -1,4 +1,4 @@ decode | near-sdk-js - v2.0.0

    Function decode

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.decodeObj2class.html b/functions/utils.decodeObj2class.html index 802daf8b..ad99b54b 100644 --- a/functions/utils.decodeObj2class.html +++ b/functions/utils.decodeObj2class.html @@ -1 +1 @@ -decodeObj2class | near-sdk-js - v2.0.0

    Function decodeObj2class

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +decodeObj2class | near-sdk-js - v2.0.0

    Function decodeObj2class

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.deserialize.html b/functions/utils.deserialize.html index e0a7b025..8ddad7ed 100644 --- a/functions/utils.deserialize.html +++ b/functions/utils.deserialize.html @@ -1 +1 @@ -deserialize | near-sdk-js - v2.0.0

    Function deserialize

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +deserialize | near-sdk-js - v2.0.0

    Function deserialize

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.encode.html b/functions/utils.encode.html index 0cec39bb..193807d2 100644 --- a/functions/utils.encode.html +++ b/functions/utils.encode.html @@ -1,4 +1,4 @@ encode | near-sdk-js - v2.0.0

    Function encode

    • encode(s): Uint8Array

    • Encode the string to Uint8Array with UTF-8 encoding

      Parameters

      • s: string

        String to encode

      Returns Uint8Array

      result Uint8Array

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.getValueWithOptions.html b/functions/utils.getValueWithOptions.html index a457fb76..73931227 100644 --- a/functions/utils.getValueWithOptions.html +++ b/functions/utils.getValueWithOptions.html @@ -1 +1 @@ -getValueWithOptions | near-sdk-js - v2.0.0

    Function getValueWithOptions

    • getValueWithOptions<DataType>(subDatatype, value, options?): DataType | null

    • Type Parameters

      • DataType

      Parameters

      • subDatatype: unknown
      • value: Uint8Array
      • options: Omit<GetOptions<DataType>, "serializer"> = {}

      Returns DataType | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getValueWithOptions | near-sdk-js - v2.0.0

    Function getValueWithOptions

    • getValueWithOptions<DataType>(subDatatype, value, options?): DataType | null

    • Type Parameters

      • DataType

      Parameters

      • subDatatype: unknown
      • value: Uint8Array
      • options: Omit<GetOptions<DataType>, "serializer"> = {}

      Returns DataType | null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.serialize.html b/functions/utils.serialize.html index bf207af9..7a033399 100644 --- a/functions/utils.serialize.html +++ b/functions/utils.serialize.html @@ -1 +1 @@ -serialize | near-sdk-js - v2.0.0

    Function serialize

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +serialize | near-sdk-js - v2.0.0

    Function serialize

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.serializeValueWithOptions.html b/functions/utils.serializeValueWithOptions.html index adeebc5d..2632a30b 100644 --- a/functions/utils.serializeValueWithOptions.html +++ b/functions/utils.serializeValueWithOptions.html @@ -1 +1 @@ -serializeValueWithOptions | near-sdk-js - v2.0.0

    Function serializeValueWithOptions

    • serializeValueWithOptions<DataType>(value, __namedParameters?): Uint8Array

    • Type Parameters

      • DataType

      Parameters

      • value: DataType
      • __namedParameters: Pick<GetOptions<DataType>, "serializer"> = ...

      Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +serializeValueWithOptions | near-sdk-js - v2.0.0

    Function serializeValueWithOptions

    • serializeValueWithOptions<DataType>(value, __namedParameters?): Uint8Array

    • Type Parameters

      • DataType

      Parameters

      • value: DataType
      • __namedParameters: Pick<GetOptions<DataType>, "serializer"> = ...

      Returns Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.str.html b/functions/utils.str.html index cd33377f..5b784aa7 100644 --- a/functions/utils.str.html +++ b/functions/utils.str.html @@ -1,4 +1,4 @@ str | near-sdk-js - v2.0.0

    Function str

    • str(a): string

    • Convert a Uint8Array to string, each uint8 to the single character of that char code

      Parameters

      • a: Uint8Array

        Uint8Array to convert

      Returns string

      result string

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/utils.validateAccountId.html b/functions/utils.validateAccountId.html index dc212f88..ec236cdd 100644 --- a/functions/utils.validateAccountId.html +++ b/functions/utils.validateAccountId.html @@ -1,4 +1,4 @@ validateAccountId | near-sdk-js - v2.0.0

    Function validateAccountId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index 7c74c1a2..3022d683 100644 --- a/index.html +++ b/index.html @@ -1,12 +1,11 @@ near-sdk-js - v2.0.0

    near-sdk-js - v2.0.0

    NEAR JavaScript SDK

    + + Documentation + Version - - - Documentation - License: LICENSE @@ -16,22 +15,26 @@

    A JavaScript library for writing NEAR smart contracts.

    -

    Prerequisites

      -
    • node >=14 <16.6.0 || >16.6.0
      • -
    • pnpm >=7
      • -
    -

    Quick Start

    Use create-near-app to quickly get started writing smart contracts in JavaScript on NEAR.

    -
    npx create-near-app
+
    import { NearBindgen, near, call, view } from 'near-sdk-js';

    @NearBindgen({})
    class HelloNear {
      greeting: string = 'Hello';

      @view({}) // This method is read-only and can be called for free
      get_greeting(): string {
        return this.greeting;
      }

      @call({}) // This method changes the state, for which it cost gas
      set_greeting({ greeting }: { greeting: string }): void {
        near.log(`Saving greeting ${greeting}`);
        this.greeting = greeting;
      }
    }
 
    
-
    This will scaffold a basic template for you 😎
    
+
    See more in the Anatomy of a Contract.
    
 
    Documentation
    
+
    Prerequisites
      
+
    • node >=14 <16.6.0 || >16.6.0
      • 
+
    • pnpm >=7
      • 
+
    
+
    Quick Start
    Use create-near-app to quickly get started writing smart contracts in JavaScript on NEAR.
    
+
    npx create-near-app
+
    
+
    This will scaffold a basic template for you 😎
    
 
    Contributing
    If you are interested in contributing, please look at the contributing guidelines.
    
 
 
    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.
    
-

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/types_collections.GetOptions.html b/interfaces/types_collections.GetOptions.html index c9ed1a3e..b38f36fd 100644 --- a/interfaces/types_collections.GetOptions.html +++ b/interfaces/types_collections.GetOptions.html @@ -1,13 +1,13 @@ GetOptions | 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;
    }

    Type Parameters

    • DataType

    Properties

    defaultValue? +
    interface GetOptions {
        defaultValue?: DataType;
        deserializer?(valueToDeserialize): unknown;
        reconstructor?(value): DataType;
        serializer?(valueToSerialize): Uint8Array;
    }

    Type Parameters

    • DataType

    Properties

    defaultValue?

    Methods

    deserializer? reconstructor? serializer?

    Properties

    Optional defaultValue

    defaultValue?: DataType

    A default value to return if the original value is not present or null.

    -

    Methods

    Optional deserializer

    Methods

    Optional deserializer

    • deserializer(valueToDeserialize): unknown

    • A deserializer function to customize the deserialization of values after reading from NEAR storage for this call.

      Parameters

      • valueToDeserialize: Uint8Array

        The Uint8Array retrieved from NEAR storage to deserialize.

        -

      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.

      +

    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 deserializer or default deserialization function.

        -

      Returns DataType

    Optional serializer

    • serializer(valueToSerialize): Uint8Array

    • A serializer function to customize the serialization of the collection for this call.

      +

    Returns DataType

    Optional serializer

    • serializer(valueToSerialize): Uint8Array

    • A serializer function to customize the serialization of the collection for this call.

      Parameters

      • valueToSerialize: unknown

        The value that will be serialized - either the DataType or a unknown value.

        -

      Returns Uint8Array

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Uint8Array

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/utils.Env.html b/interfaces/utils.Env.html index 6ec07626..f51f9bb4 100644 --- a/interfaces/utils.Env.html +++ b/interfaces/utils.Env.html @@ -1,5 +1,5 @@ -Env | near-sdk-js - v2.0.0

    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;
    }

    Methods

    latin1_string_to_uint8array +Env | near-sdk-js - v2.0.0

    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;
    }

    Methods

    latin1_string_to_uint8array uint8array_to_latin1_string uint8array_to_utf8_string utf8_string_to_uint8array -

    Methods

    latin1_string_to_uint8array

    uint8array_to_latin1_string

    uint8array_to_utf8_string

    utf8_string_to_uint8array

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    latin1_string_to_uint8array

    uint8array_to_latin1_string

    uint8array_to_utf8_string

    utf8_string_to_uint8array

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/utils.IntoStorageKey.html b/interfaces/utils.IntoStorageKey.html index 200c0be1..a756a7d8 100644 --- a/interfaces/utils.IntoStorageKey.html +++ b/interfaces/utils.IntoStorageKey.html @@ -1,3 +1,3 @@ IntoStorageKey | near-sdk-js - v2.0.0

    Interface IntoStorageKey

    When implemented, allow object to be stored as collection key

    -
    interface IntoStorageKey {
        into_storage_key(): string;
    }

    Methods

    into_storage_key -

    Methods

    into_storage_key

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
    interface IntoStorageKey {
        into_storage_key(): string;
    }

    Methods

    into_storage_key +

    Methods

    into_storage_key

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/api.html b/modules/api.html index 12828a57..da5d532e 100644 --- a/modules/api.html +++ b/modules/api.html @@ -1,4 +1,4 @@ -api | near-sdk-js - v2.0.0

    Module api

    Index

    Functions

    accountBalance +api | near-sdk-js - v2.0.0

    Module api

    Index

    Functions

    accountBalance accountLockedBalance altBn128G1Multiexp altBn128G1Sum diff --git a/modules/cli_abi.html b/modules/cli_abi.html index 737465ab..e41b5d18 100644 --- a/modules/cli_abi.html +++ b/modules/cli_abi.html @@ -1,2 +1,2 @@ -cli/abi | near-sdk-js - v2.0.0

    Module cli/abi

    Index

    Functions

    runAbiCompilerPlugin +cli/abi | near-sdk-js - v2.0.0

    Module cli/abi

    Index

    Functions

    runAbiCompilerPlugin

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/cli_build_tools_include_bytes.html b/modules/cli_build_tools_include_bytes.html index 457c9c95..cc890855 100644 --- a/modules/cli_build_tools_include_bytes.html +++ b/modules/cli_build_tools_include_bytes.html @@ -1,2 +1,2 @@ -cli/build-tools/include-bytes | near-sdk-js - v2.0.0

    Module cli/build-tools/include-bytes

    Index

    Functions

    default +cli/build-tools/include-bytes | near-sdk-js - v2.0.0

    Module cli/build-tools/include-bytes

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/cli_build_tools_near_bindgen_exporter.html b/modules/cli_build_tools_near_bindgen_exporter.html index d8b1ec14..81478103 100644 --- a/modules/cli_build_tools_near_bindgen_exporter.html +++ b/modules/cli_build_tools_near_bindgen_exporter.html @@ -1,2 +1,2 @@ -cli/build-tools/near-bindgen-exporter | near-sdk-js - v2.0.0

    Module cli/build-tools/near-bindgen-exporter

    Index

    Functions

    default +cli/build-tools/near-bindgen-exporter | near-sdk-js - v2.0.0

    Module cli/build-tools/near-bindgen-exporter

    Index

    Functions

    default

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/cli_cli.html b/modules/cli_cli.html index b355ecad..b2cef4e6 100644 --- a/modules/cli_cli.html +++ b/modules/cli_cli.html @@ -1,4 +1,4 @@ -cli/cli | near-sdk-js - v2.0.0

    Module cli/cli

    Index

    Functions

    buildCom +cli/cli | near-sdk-js - v2.0.0

    Module cli/cli

    Index

    Functions

    buildCom checkTypescriptCom createJsFileWithRollupCom generateAbi diff --git a/modules/cli_post_install.html b/modules/cli_post_install.html index cc9ad35b..0e708282 100644 --- a/modules/cli_post_install.html +++ b/modules/cli_post_install.html @@ -1 +1 @@ -cli/post-install | near-sdk-js - v2.0.0

    Module cli/post-install

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +cli/post-install | near-sdk-js - v2.0.0

    Module cli/post-install

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/cli_utils.html b/modules/cli_utils.html index e0a56706..74dafd07 100644 --- a/modules/cli_utils.html +++ b/modules/cli_utils.html @@ -1,4 +1,4 @@ -cli/utils | near-sdk-js - v2.0.0

    Module cli/utils

    Index

    Functions

    download +cli/utils | near-sdk-js - v2.0.0

    Module cli/utils

    Index

    Functions

    download executeCommand validateContract

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/collections.html b/modules/collections.html index b4642961..a5b46c26 100644 --- a/modules/collections.html +++ b/modules/collections.html @@ -1,4 +1,4 @@ -collections | near-sdk-js - v2.0.0

    Module collections

    References

    LookupMap +collections | near-sdk-js - v2.0.0

    Module collections

    References

    LookupMap LookupSet SubType UnorderedMap diff --git a/modules/collections_lookup_map.html b/modules/collections_lookup_map.html index 082fc36b..7dc13736 100644 --- a/modules/collections_lookup_map.html +++ b/modules/collections_lookup_map.html @@ -1,2 +1,2 @@ -collections/lookup-map | near-sdk-js - v2.0.0

    Module collections/lookup-map

    Index

    Classes

    LookupMap +collections/lookup-map | near-sdk-js - v2.0.0

    Module collections/lookup-map

    Index

    Classes

    LookupMap

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/collections_lookup_set.html b/modules/collections_lookup_set.html index 0c2cf57b..1ce5dcf6 100644 --- a/modules/collections_lookup_set.html +++ b/modules/collections_lookup_set.html @@ -1,2 +1,2 @@ -collections/lookup-set | near-sdk-js - v2.0.0

    Module collections/lookup-set

    Index

    Classes

    LookupSet +collections/lookup-set | near-sdk-js - v2.0.0

    Module collections/lookup-set

    Index

    Classes

    LookupSet

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/collections_subtype.html b/modules/collections_subtype.html index 045669c0..bef8051f 100644 --- a/modules/collections_subtype.html +++ b/modules/collections_subtype.html @@ -1,2 +1,2 @@ -collections/subtype | near-sdk-js - v2.0.0

    Module collections/subtype

    Index

    Classes

    SubType +collections/subtype | near-sdk-js - v2.0.0

    Module collections/subtype

    Index

    Classes

    SubType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/collections_unordered_map.html b/modules/collections_unordered_map.html index ab7db10a..a817ea89 100644 --- a/modules/collections_unordered_map.html +++ b/modules/collections_unordered_map.html @@ -1,2 +1,2 @@ -collections/unordered-map | near-sdk-js - v2.0.0

    Module collections/unordered-map

    Index

    Classes

    UnorderedMap +collections/unordered-map | near-sdk-js - v2.0.0

    Module collections/unordered-map

    Index

    Classes

    UnorderedMap

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/collections_unordered_set.html b/modules/collections_unordered_set.html index 5f9de64a..96e3da5c 100644 --- a/modules/collections_unordered_set.html +++ b/modules/collections_unordered_set.html @@ -1,2 +1,2 @@ -collections/unordered-set | near-sdk-js - v2.0.0

    Module collections/unordered-set

    Index

    Classes

    UnorderedSet +collections/unordered-set | near-sdk-js - v2.0.0

    Module collections/unordered-set

    Index

    Classes

    UnorderedSet

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/collections_vector.html b/modules/collections_vector.html index 94e1cc6a..e5258f10 100644 --- a/modules/collections_vector.html +++ b/modules/collections_vector.html @@ -1,3 +1,3 @@ -collections/vector | near-sdk-js - v2.0.0

    Module collections/vector

    Index

    Classes

    Vector +collections/vector | near-sdk-js - v2.0.0

    Module collections/vector

    Index

    Classes

    Vector VectorIterator

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/index.html b/modules/index.html index 236021e0..afd6dc0a 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | near-sdk-js - v2.0.0

    Module index

    References

    AccountId +index | near-sdk-js - v2.0.0

    Module index

    References

    AccountId AddAccessKey AddFullAccessKey Balance diff --git a/modules/near_bindgen.html b/modules/near_bindgen.html index 32a62dcc..72207f69 100644 --- a/modules/near_bindgen.html +++ b/modules/near_bindgen.html @@ -1,4 +1,4 @@ -near-bindgen | near-sdk-js - v2.0.0

    Module near-bindgen

    Index

    Functions

    NearBindgen +near-bindgen | near-sdk-js - v2.0.0

    Module near-bindgen

    Index

    Functions

    NearBindgen call initialize middleware diff --git a/modules/promise.html b/modules/promise.html index edef89b1..f136d9ab 100644 --- a/modules/promise.html +++ b/modules/promise.html @@ -1,4 +1,4 @@ -promise | near-sdk-js - v2.0.0

    Module promise

    Index

    Classes

    AddAccessKey +promise | near-sdk-js - v2.0.0

    Module promise

    Index

    Classes

    AddAccessKey AddFullAccessKey CreateAccount DeleteAccount diff --git a/modules/types.html b/modules/types.html index 51f95220..6ee96f09 100644 --- a/modules/types.html +++ b/modules/types.html @@ -1,4 +1,4 @@ -types | near-sdk-js - v2.0.0

    Module types

    References

    AccountId +types | near-sdk-js - v2.0.0

    Module types

    References

    AccountId Balance Base58Error BlockHeight diff --git a/modules/types_account_id.html b/modules/types_account_id.html index 2e578dc7..d626c0de 100644 --- a/modules/types_account_id.html +++ b/modules/types_account_id.html @@ -1,2 +1,2 @@ -types/account_id | near-sdk-js - v2.0.0

    Module types/account_id

    Index

    Type Aliases

    AccountId +types/account_id | near-sdk-js - v2.0.0

    Module types/account_id

    Index

    Type Aliases

    AccountId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/types_collections.html b/modules/types_collections.html index ddd929d0..9348d4df 100644 --- a/modules/types_collections.html +++ b/modules/types_collections.html @@ -1,2 +1,2 @@ -types/collections | near-sdk-js - v2.0.0

    Module types/collections

    Index

    Interfaces

    GetOptions +types/collections | near-sdk-js - v2.0.0

    Module types/collections

    Index

    Interfaces

    GetOptions

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/types_gas.html b/modules/types_gas.html index edb7396f..a2c51ab7 100644 --- a/modules/types_gas.html +++ b/modules/types_gas.html @@ -1,3 +1,3 @@ -types/gas | near-sdk-js - v2.0.0

    Module types/gas

    Index

    Type Aliases

    Gas +types/gas | near-sdk-js - v2.0.0

    Module types/gas

    Index

    Type Aliases

    Gas

    Variables

    ONE_TERA_GAS

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/types_primitives.html b/modules/types_primitives.html index 837e3ce8..051f53e8 100644 --- a/modules/types_primitives.html +++ b/modules/types_primitives.html @@ -1,4 +1,4 @@ -types/primitives | near-sdk-js - v2.0.0

    Module types/primitives

    Index

    Type Aliases

    Balance +types/primitives | near-sdk-js - v2.0.0

    Module types/primitives

    Index

    Type Aliases

    Balance BlockHeight EpochHeight GasWeight diff --git a/modules/types_public_key.html b/modules/types_public_key.html index 762dcc11..e9b841f2 100644 --- a/modules/types_public_key.html +++ b/modules/types_public_key.html @@ -1,4 +1,4 @@ -types/public_key | near-sdk-js - v2.0.0

    Module types/public_key

    Index

    Enumerations

    CurveType +types/public_key | near-sdk-js - v2.0.0

    Module types/public_key

    Index

    Enumerations

    CurveType

    Classes

    Base58Error InvalidLengthError ParsePublicKeyError diff --git a/modules/types_vm_types.html b/modules/types_vm_types.html index 080ddf62..e03d021a 100644 --- a/modules/types_vm_types.html +++ b/modules/types_vm_types.html @@ -1,4 +1,4 @@ -types/vm_types | near-sdk-js - v2.0.0

    Module types/vm_types

    Index

    Enumerations

    PromiseError +types/vm_types | near-sdk-js - v2.0.0

    Module types/vm_types

    Index

    Enumerations

    PromiseError PromiseResult

    Type Aliases

    IteratorIndex ReceiptIndex diff --git a/modules/utils.html b/modules/utils.html index 85f28859..147bc0cc 100644 --- a/modules/utils.html +++ b/modules/utils.html @@ -1,4 +1,4 @@ -utils | near-sdk-js - v2.0.0

    Module utils

    Index

    Classes

    TextDecoder +utils | near-sdk-js - v2.0.0

    Module utils

    Index

    Classes

    TextDecoder TextEncoder

    Interfaces

    Env IntoStorageKey diff --git a/modules/version.html b/modules/version.html index 998cb262..2b329bb8 100644 --- a/modules/version.html +++ b/modules/version.html @@ -1,2 +1,2 @@ -version | near-sdk-js - v2.0.0

    Module version

    Index

    Variables

    LIB_VERSION +version | near-sdk-js - v2.0.0

    Module version

    Index

    Variables

    LIB_VERSION

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/promise.PromiseOrValue.html b/types/promise.PromiseOrValue.html index 06fb84c7..4023d748 100644 --- a/types/promise.PromiseOrValue.html +++ b/types/promise.PromiseOrValue.html @@ -1 +1 @@ -PromiseOrValue | near-sdk-js - v2.0.0

    Type alias PromiseOrValue<T>

    PromiseOrValue<T>: NearPromise | T

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PromiseOrValue | near-sdk-js - v2.0.0

    Type alias PromiseOrValue<T>

    PromiseOrValue<T>: NearPromise | T

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_account_id.AccountId.html b/types/types_account_id.AccountId.html index 6d0f7eab..dbeafddf 100644 --- a/types/types_account_id.AccountId.html +++ b/types/types_account_id.AccountId.html @@ -1,2 +1,2 @@ AccountId | near-sdk-js - v2.0.0

    Type alias AccountId

    AccountId: string

    A string that represents a NEAR account ID.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_gas.Gas.html b/types/types_gas.Gas.html index 3334fc50..cd7807bc 100644 --- a/types/types_gas.Gas.html +++ b/types/types_gas.Gas.html @@ -1,2 +1,2 @@ Gas | near-sdk-js - v2.0.0

    Type alias Gas

    Gas: bigint

    The Gas amount specified in yoctoNEAR.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_primitives.Balance.html b/types/types_primitives.Balance.html index 34633dc9..50fee57c 100644 --- a/types/types_primitives.Balance.html +++ b/types/types_primitives.Balance.html @@ -1,2 +1,2 @@ Balance | near-sdk-js - v2.0.0

    Type alias Balance

    Balance: bigint

    The amount of tokens in yoctoNEAR.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_primitives.BlockHeight.html b/types/types_primitives.BlockHeight.html index 60a26735..1ac3df66 100644 --- a/types/types_primitives.BlockHeight.html +++ b/types/types_primitives.BlockHeight.html @@ -1,2 +1,2 @@ BlockHeight | near-sdk-js - v2.0.0

    Type alias BlockHeight

    BlockHeight: bigint

    A large integer representing the block height.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_primitives.EpochHeight.html b/types/types_primitives.EpochHeight.html index 99efda26..9e9b7ce0 100644 --- a/types/types_primitives.EpochHeight.html +++ b/types/types_primitives.EpochHeight.html @@ -1,2 +1,2 @@ EpochHeight | near-sdk-js - v2.0.0

    Type alias EpochHeight

    EpochHeight: bigint

    A large integer representing the epoch height.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_primitives.GasWeight.html b/types/types_primitives.GasWeight.html index 530fdbce..d0b62116 100644 --- a/types/types_primitives.GasWeight.html +++ b/types/types_primitives.GasWeight.html @@ -1,2 +1,2 @@ GasWeight | near-sdk-js - v2.0.0

    Type alias GasWeight

    GasWeight: bigint

    The amount of Gas Weight in integers - whole numbers.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_primitives.Nonce.html b/types/types_primitives.Nonce.html index 35d0e5de..ef78a334 100644 --- a/types/types_primitives.Nonce.html +++ b/types/types_primitives.Nonce.html @@ -1,2 +1,2 @@ Nonce | near-sdk-js - v2.0.0

    Type alias Nonce

    Nonce: bigint

    A large integer representing the nonce.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_primitives.StorageUsage.html b/types/types_primitives.StorageUsage.html index 5325d3d7..a2aac6dc 100644 --- a/types/types_primitives.StorageUsage.html +++ b/types/types_primitives.StorageUsage.html @@ -1,2 +1,2 @@ StorageUsage | near-sdk-js - v2.0.0

    Type alias StorageUsage

    StorageUsage: bigint

    The amount of storage used in yoctoNEAR.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_vm_types.IteratorIndex.html b/types/types_vm_types.IteratorIndex.html index 9a6e0b71..e10df108 100644 --- a/types/types_vm_types.IteratorIndex.html +++ b/types/types_vm_types.IteratorIndex.html @@ -1,2 +1,2 @@ IteratorIndex | near-sdk-js - v2.0.0

    Type alias IteratorIndex

    IteratorIndex: bigint

    The index for iterators.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/types_vm_types.ReceiptIndex.html b/types/types_vm_types.ReceiptIndex.html index 0ef3de91..dd299290 100644 --- a/types/types_vm_types.ReceiptIndex.html +++ b/types/types_vm_types.ReceiptIndex.html @@ -1,2 +1,2 @@ ReceiptIndex | near-sdk-js - v2.0.0

    Type alias ReceiptIndex

    ReceiptIndex: bigint

    The index for NEAR receipts.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/utils.Mutable.html b/types/utils.Mutable.html index d665dbc6..ae7c9ff4 100644 --- a/types/utils.Mutable.html +++ b/types/utils.Mutable.html @@ -1 +1 @@ -Mutable | near-sdk-js - v2.0.0

    Type alias Mutable<T>

    Mutable<T>: {
        -readonly [P in keyof T]: T[P]
    }

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Mutable | near-sdk-js - v2.0.0

    Type alias Mutable<T>

    Mutable<T>: {
        -readonly [P in keyof T]: T[P]
    }

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/utils.NearAmount.html b/types/utils.NearAmount.html index 41958b54..e293a146 100644 --- a/types/utils.NearAmount.html +++ b/types/utils.NearAmount.html @@ -1,2 +1,2 @@ NearAmount | near-sdk-js - v2.0.0

    Type alias NearAmount

    NearAmount: number | bigint

    A number that specifies the amount of NEAR in yoctoNEAR.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/utils.PromiseIndex.html b/types/utils.PromiseIndex.html index 790c9dea..73772b5c 100644 --- a/types/utils.PromiseIndex.html +++ b/types/utils.PromiseIndex.html @@ -1,2 +1,2 @@ PromiseIndex | near-sdk-js - v2.0.0

    Type alias PromiseIndex

    PromiseIndex: number | bigint

    A PromiseIndex which represents the ID of a NEAR Promise.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/utils.Register.html b/types/utils.Register.html index 03a72495..e554c3a1 100644 --- a/types/utils.Register.html +++ b/types/utils.Register.html @@ -1,2 +1,2 @@ Register | near-sdk-js - v2.0.0

    Type alias Register

    Register: number | bigint

    A number that specifies the ID of a register in the NEAR WASM virtual machine.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/types_gas.ONE_TERA_GAS.html b/variables/types_gas.ONE_TERA_GAS.html index 3d27eba1..939daecf 100644 --- a/variables/types_gas.ONE_TERA_GAS.html +++ b/variables/types_gas.ONE_TERA_GAS.html @@ -1,2 +1,2 @@ ONE_TERA_GAS | near-sdk-js - v2.0.0

    Variable ONE_TERA_GASConst

    ONE_TERA_GAS: Gas = ...

    One TGas - Tera Gas. 10^12 yoctoNEAR.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/types_primitives.ONE_NEAR.html b/variables/types_primitives.ONE_NEAR.html index 4dd187f0..eda2a5f4 100644 --- a/variables/types_primitives.ONE_NEAR.html +++ b/variables/types_primitives.ONE_NEAR.html @@ -1,2 +1,2 @@ ONE_NEAR | near-sdk-js - v2.0.0

    Variable ONE_NEARConst

    ONE_NEAR: Balance = ...

    One NEAR. 1 NEAR = 10^24 yoctoNEAR.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/types_primitives.ONE_YOCTO.html b/variables/types_primitives.ONE_YOCTO.html index 30f63e92..af69d8e7 100644 --- a/variables/types_primitives.ONE_YOCTO.html +++ b/variables/types_primitives.ONE_YOCTO.html @@ -1,2 +1,2 @@ ONE_YOCTO | near-sdk-js - v2.0.0

    Variable ONE_YOCTOConst

    ONE_YOCTO: Balance = ...

    One yoctoNEAR. 10^-24 NEAR.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/utils.ERR_INCONSISTENT_STATE.html b/variables/utils.ERR_INCONSISTENT_STATE.html index 6e1948da..daa2c083 100644 --- a/variables/utils.ERR_INCONSISTENT_STATE.html +++ b/variables/utils.ERR_INCONSISTENT_STATE.html @@ -1 +1 @@ -ERR_INCONSISTENT_STATE | near-sdk-js - v2.0.0

    Variable ERR_INCONSISTENT_STATEConst

    ERR_INCONSISTENT_STATE: "The collection is an inconsistent state. Did previous smart contract execution terminate unexpectedly?" = "The collection is an inconsistent state. Did previous smart contract execution terminate unexpectedly?"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ERR_INCONSISTENT_STATE | near-sdk-js - v2.0.0

    Variable ERR_INCONSISTENT_STATEConst

    ERR_INCONSISTENT_STATE: "The collection is an inconsistent state. Did previous smart contract execution terminate unexpectedly?" = "The collection is an inconsistent state. Did previous smart contract execution terminate unexpectedly?"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/utils.ERR_INDEX_OUT_OF_BOUNDS.html b/variables/utils.ERR_INDEX_OUT_OF_BOUNDS.html index 44c1ffe3..247916a9 100644 --- a/variables/utils.ERR_INDEX_OUT_OF_BOUNDS.html +++ b/variables/utils.ERR_INDEX_OUT_OF_BOUNDS.html @@ -1 +1 @@ -ERR_INDEX_OUT_OF_BOUNDS | near-sdk-js - v2.0.0

    Variable ERR_INDEX_OUT_OF_BOUNDSConst

    ERR_INDEX_OUT_OF_BOUNDS: "Index out of bounds" = "Index out of bounds"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ERR_INDEX_OUT_OF_BOUNDS | near-sdk-js - v2.0.0

    Variable ERR_INDEX_OUT_OF_BOUNDSConst

    ERR_INDEX_OUT_OF_BOUNDS: "Index out of bounds" = "Index out of bounds"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/version.LIB_VERSION.html b/variables/version.LIB_VERSION.html index a646378c..b3fd9759 100644 --- a/variables/version.LIB_VERSION.html +++ b/variables/version.LIB_VERSION.html @@ -1 +1 @@ -LIB_VERSION | near-sdk-js - v2.0.0

    Variable LIB_VERSIONConst

    LIB_VERSION: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +LIB_VERSION | near-sdk-js - v2.0.0

    Variable LIB_VERSIONConst

    LIB_VERSION: string = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file