NearPromise
promise • Docs
near-sdk-js v2.0.0 / promise / NearPromise
Class: NearPromise
A high level class to construct and work with NEAR promises.
Constructors
new NearPromise()
new NearPromise(
subtype,shouldReturn):NearPromise
Parameters
• subtype: PromiseSubtype
The subtype of the promise.
• shouldReturn: boolean
Whether the promise should return.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:372
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 functions to authorize.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:535
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 functions to authorize.
• nonce: bigint
The nonce to use.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:560
addFullAccessKey()
addFullAccessKey(
publicKey):NearPromise
Creates a add full 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 full access key.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:511
addFullAccessKeyWithNonce()
addFullAccessKeyWithNonce(
publicKey,nonce):NearPromise
Creates a add full 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 full access key.
• nonce: bigint
The nonce to use.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:522
and()
and(
other):NearPromise
Joins the provided promise with the current promise, making the current promise a joint promise subtype.
Parameters
• other: NearPromise
The promise to join with the current promise.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:595
asReturn()
asReturn():
NearPromise
Sets the shouldReturn field to true.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:624
build()
build():
PromiseIndex
Attach the promise to transaction but does not return it. The promise will be executed, but whether it success or not will not affect the transaction result. If you want the promise fail also makes the transaction fail, you can simply return the promise from a
Returns
Call
method.
Defined in
packages/near-sdk-js/src/promise.ts:654
constructRecursively()
constructRecursively():
PromiseIndex
Recursively goes through the current promise to get the promise index.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:632
createAccount()
createAccount():
NearPromise
Creates a create account promise action and adds it to the current promise.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:397
deleteAccount()
deleteAccount(
beneficiaryId):NearPromise
Creates a delete account promise action and adds it to the current promise.
Parameters
• beneficiaryId: string
The beneficiary of the account deletion - the account to receive all of the remaining funds of the deleted account.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:586
deleteKey()
deleteKey(
publicKey):NearPromise
Creates a delete key promise action and adds it to the current promise.
Parameters
• publicKey: PublicKey
The public key to delete from the account.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:577
deployContract()
deployContract(
code):NearPromise
Creates a deploy contract promise action and adds it to the current promise.
Parameters
• code: Uint8Array
The code of the contract to be deployed.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:406
functionCall()
functionCall(
functionName,args,amount,gas):NearPromise
Creates a function call promise action and adds it to the current promise.
Parameters
• functionName: string
The name of the function to be called.
• 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
Defined in
packages/near-sdk-js/src/promise.ts:418
functionCallRaw()
functionCallRaw(
functionName,args,amount,gas):NearPromise
Creates a function call raw promise action and adds it to the current promise.
Parameters
• functionName: string
The name of the function to be called.
• 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
Defined in
packages/near-sdk-js/src/promise.ts:435
functionCallWeight()
functionCallWeight(
functionName,args,amount,gas,weight):NearPromise
Creates a function call weight promise action and adds it to the current promise.
Parameters
• functionName: string
The name of the function to be called.
• 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.
• weight: bigint
The weight of unused Gas to use.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:453
functionCallWeightRaw()
functionCallWeightRaw(
functionName,args,amount,gas,weight):NearPromise
Creates a function call weight raw promise action and adds it to the current promise.
Parameters
• functionName: string
The name of the function to be called.
• 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.
• weight: bigint
The weight of unused Gas to use.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:474
onReturn()
onReturn():
void
Called by NearBindgen, when return object is a NearPromise instance.
Returns
void
Defined in
packages/near-sdk-js/src/promise.ts:645
stake()
stake(
amount,publicKey):NearPromise
Creates a stake promise action and adds it to the current promise.
Parameters
• amount: bigint
The amount of NEAR to transfer.
• publicKey: PublicKey
The public key to use for staking.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:501
then()
then(
other):NearPromise
Adds a callback to the current promise.
Parameters
• other: NearPromise
The promise to be executed as the promise.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:605
transfer()
transfer(
amount):NearPromise
Creates a transfer promise action and adds it to the current promise.
Parameters
• amount: bigint
The amount of NEAR to transfer.
Returns
Defined in
packages/near-sdk-js/src/promise.ts:491
new()
staticnew(accountId):NearPromise
Creates a new promise to the provided account ID.
Parameters
• accountId: string
The account ID on which to call the promise.
Returns
Defined in
Last updated