Class Account2FA

This class provides common account related RPC calls including signing transactions with a KeyPair.

Hierarchy

AccountMultisig
- Account2FA

Constructors

constructor

new Account2FA(connection, accountId, options): Account2FA
Parameters
- connection: Connection
- accountId: string
- options: any
Returns Account2FA
Overrides AccountMultisig.constructor
- Defined in packages/accounts/src/account_2fa.ts:37

Properties

`Readonly` accountId

accountId: string

`Readonly` connection

connection: Connection

getCode

getCode: getCodeFunction

helperUrl

helperUrl: string = 'https://helper.testnet.near.org'

onAddRequestResult

onAddRequestResult: ((any) => any)

Type declaration

- (any): any
- Parameters
  - any: any
  Returns any

onConfirmResult

onConfirmResult: ((any) => any)

Type declaration

- (any): any
- Parameters
  - any: any
  Returns any

sendCode

sendCode: sendCodeFunction

Account2FA has options object where you can provide callbacks for:

sendCode: how to send the 2FA code in case you don't use NEAR Contract Helper
getCode: how to get code from user (use this to provide custom UI/UX for prompt of 2FA code)
onResult: the tx result after it's been confirmed by NEAR Contract Helper

storage

storage: any

verifyCode

verifyCode: verifyCodeFunction

Methods

addKey

addKey(publicKey, contractId?, methodNames?, amount?): Promise<FinalExecutionOutcome>
Parameters
- publicKey: string | PublicKey
  A public key to be associated with the contract
- Optional contractId: string
  NEAR account where the contract is deployed
- Optional methodNames: string | string[]
  The method names on the contract that should be allowed to be called. Pass null for no method names and '' or [] for any method names.
- Optional amount: BN
  Payment in yoctoⓃ that is sent to the contract during this function call
Returns Promise<FinalExecutionOutcome>
See
https://docs.near.org/concepts/basics/accounts/access-keys

Todo
expand this API to support more options.
Inherited from AccountMultisig.addKey
- Defined in packages/accounts/src/account.ts:420

checkMultisigCodeAndStateStatus

checkMultisigCodeAndStateStatus(contractBytes?): Promise<{
codeStatus: MultisigCodeStatus;
stateStatus: MultisigStateStatus;
}>
Parameters
- Optional contractBytes: Uint8Array
Returns Promise<{
codeStatus: MultisigCodeStatus;
stateStatus: MultisigStateStatus;
}>
Inherited from AccountMultisig.checkMultisigCodeAndStateStatus
- Defined in packages/accounts/src/account_multisig.ts:98

createAccount

createAccount(newAccountId, publicKey, amount): Promise<FinalExecutionOutcome>
Parameters
- newAccountId: string
  NEAR account name to be created
- publicKey: string | PublicKey
  A public key created from the masterAccount
- amount: BN
Returns Promise<FinalExecutionOutcome>
Inherited from AccountMultisig.createAccount
- Defined in packages/accounts/src/account.ts:351

createAndDeployContract

createAndDeployContract(contractId, publicKey, data, amount): Promise<Account>
Create a new account and deploy a contract to it
Parameters
- contractId: string
  NEAR account where the contract is deployed
- publicKey: string | PublicKey
  The public key to add to the created contract account
- data: Uint8Array
  The compiled contract code
- amount: BN
  of NEAR to transfer to the created contract account. Transfer enough to pay for storage https://docs.near.org/docs/concepts/storage-staking
Returns Promise<Account>
Inherited from AccountMultisig.createAndDeployContract
- Defined in packages/accounts/src/account.ts:326

deleteAccount

deleteAccount(beneficiaryId): Promise<FinalExecutionOutcome>
Parameters
- beneficiaryId: string
  The NEAR account that will receive the remaining Ⓝ balance from the account being deleted
Returns Promise<FinalExecutionOutcome>
Inherited from AccountMultisig.deleteAccount
- Defined in packages/accounts/src/account.ts:362

deleteAllRequests

deleteAllRequests(): Promise<void>
Returns Promise<void>
Inherited from AccountMultisig.deleteAllRequests
- Defined in packages/accounts/src/account_multisig.ts:137

deleteKey

deleteKey(publicKey): Promise<FinalExecutionOutcome>
Parameters
- publicKey: string | PublicKey
  The public key to be deleted
Returns Promise<FinalExecutionOutcome>
Inherited from AccountMultisig.deleteKey
- Defined in packages/accounts/src/account.ts:443

deleteRequest

deleteRequest(request_id): Promise<FinalExecutionOutcome>
Parameters
- request_id: any
Returns Promise<FinalExecutionOutcome>
Inherited from AccountMultisig.deleteRequest
- Defined in packages/accounts/src/account_multisig.ts:130

deleteUnconfirmedRequests

deleteUnconfirmedRequests(): Promise<void>
Returns Promise<void>
Inherited from AccountMultisig.deleteUnconfirmedRequests
- Defined in packages/accounts/src/account_multisig.ts:144

deployContract

deployContract(data): Promise<FinalExecutionOutcome>
Parameters
- data: Uint8Array
  The compiled contract code
Returns Promise<FinalExecutionOutcome>
Inherited from AccountMultisig.deployContract
- Defined in packages/accounts/src/account.ts:375

deployMultisig

deployMultisig(contractBytes): Promise<FinalExecutionOutcome>
Parameters
- contractBytes: Uint8Array
Returns Promise<FinalExecutionOutcome>
- Defined in packages/accounts/src/account_2fa.ts:64

disable

disable(contractBytes?, cleanupContractBytes?): Promise<FinalExecutionOutcome>
This method converts LAKs back to FAKs, clears state and deploys an 'empty' contract (contractBytes param)
Parameters
- Optional contractBytes: Uint8Array
  https://github.com/near/near-wallet/blob/master/packages/frontend/src/wasm/main.wasm?raw=true
- Optional cleanupContractBytes: Uint8Array
  https://github.com/near/core-contracts/blob/master/state-cleanup/res/state_cleanup.wasm?raw=true
Returns Promise<FinalExecutionOutcome>
- Defined in packages/accounts/src/account_2fa.ts:167

disableWithFAK

disableWithFAK(__namedParameters): Promise<FinalExecutionOutcome>
Parameters
- __namedParameters: {
  cleanupContractBytes?: Uint8Array;
  contractBytes: Uint8Array;
  }
  - Optional cleanupContractBytes?: Uint8Array
  - contractBytes: Uint8Array
Returns Promise<FinalExecutionOutcome>
- Defined in packages/accounts/src/account_2fa.ts:102

findAccessKey

findAccessKey(receiverId, actions): Promise<{
accessKey: AccessKeyView;
publicKey: PublicKey;
}>
Finds the AccessKeyView associated with the accounts PublicKey stored in the Keystore.
Parameters
- receiverId: string
  currently unused (see todo)
- actions: Action[]
  currently unused (see todo)
Returns Promise<{
accessKey: AccessKeyView;
publicKey: PublicKey;
}>
{ publicKey PublicKey; accessKey: AccessKeyView }

Todo
Find matching access key based on transaction (i.e. receiverId and actions)
Inherited from AccountMultisig.findAccessKey
- Defined in packages/accounts/src/account.ts:274

functionCall

functionCall(__namedParameters): Promise<FinalExecutionOutcome>
Execute function call
Parameters
- __namedParameters: ChangeFunctionCallOptions
Returns Promise<FinalExecutionOutcome>
Inherited from AccountMultisig.functionCall
- Defined in packages/accounts/src/account.ts:391

get2faDisableCleanupActions

get2faDisableCleanupActions(cleanupContractBytes): Promise<Action[]>
Parameters
- cleanupContractBytes: Uint8Array
Returns Promise<Action[]>
- Defined in packages/accounts/src/account_2fa.ts:125

get2faDisableKeyConversionActions

get2faDisableKeyConversionActions(): Promise<Action[]>
Returns Promise<Action[]>
- Defined in packages/accounts/src/account_2fa.ts:143

get2faMethod

get2faMethod(): Promise<{
detail: any;
kind: any;
}>
Returns Promise<{
detail: any;
kind: any;
}>
- Defined in packages/accounts/src/account_2fa.ts:251

getAccessKeys

getAccessKeys(): Promise<AccessKeyInfoView[]>
Get all access keys for the account

Returns Promise<AccessKeyInfoView[]>
See
https://docs.near.org/api/rpc/access-keys#view-access-key-list
Inherited from AccountMultisig.getAccessKeys
- Defined in packages/accounts/src/account.ts:592

getAccountBalance

getAccountBalance(): Promise<AccountBalance>
Returns calculated account balance

Returns Promise<AccountBalance>
Inherited from AccountMultisig.getAccountBalance
- Defined in packages/accounts/src/account.ts:626

getAccountDetails

getAccountDetails(): Promise<{
authorizedApps: AccountAuthorizedApp[];
}>
Returns a list of authorized apps

Returns Promise<{
authorizedApps: AccountAuthorizedApp[];
}>
Todo
update the response value to return all the different keys, not just app keys.
Inherited from AccountMultisig.getAccountDetails
- Defined in packages/accounts/src/account.ts:606

getActiveDelegatedStakeBalance

getActiveDelegatedStakeBalance(): Promise<ActiveDelegatedStakeBalance>
Returns the NEAR tokens balance and validators of a given account that is delegated to the staking pools that are part of the validators set in the current epoch.

NOTE: If the tokens are delegated to a staking pool that is currently on pause or does not have enough tokens to participate in validation, they won't be accounted for.

Returns Promise<ActiveDelegatedStakeBalance>
Inherited from AccountMultisig.getActiveDelegatedStakeBalance
- Defined in packages/accounts/src/account.ts:650

getCodeDefault

getCodeDefault(): Promise<string>
Returns Promise<string>
- Defined in packages/accounts/src/account_2fa.ts:207

getRecoveryMethods

getRecoveryMethods(): Promise<{
accountId: string;
data: any;
}>
Returns Promise<{
accountId: string;
data: any;
}>
- Defined in packages/accounts/src/account_2fa.ts:243

getRequest

getRequest(): any
Returns any
Inherited from AccountMultisig.getRequest
- Defined in packages/accounts/src/account_multisig.ts:175

getRequestIds

getRequestIds(): Promise<string[]>
Returns Promise<string[]>
Inherited from AccountMultisig.getRequestIds
- Defined in packages/accounts/src/account_multisig.ts:166

postSignedJson

postSignedJson(path, body): Promise<any>
Parameters
- path: any
- body: any
Returns Promise<any>
- Defined in packages/accounts/src/account_2fa.ts:270

promptAndVerify

promptAndVerify(): any
Returns any
- Defined in packages/accounts/src/account_2fa.ts:211

sendCodeDefault

sendCodeDefault(): Promise<any>
Returns Promise<any>
- Defined in packages/accounts/src/account_2fa.ts:195

sendMoney

sendMoney(receiverId, amount): Promise<FinalExecutionOutcome>
Parameters
- receiverId: string
  NEAR account receiving Ⓝ
- amount: BN
  Amount to send in yoctoⓃ
Returns Promise<FinalExecutionOutcome>
Inherited from AccountMultisig.sendMoney
- Defined in packages/accounts/src/account.ts:340

setRequest

setRequest(data): any
Parameters
- data: any
Returns any
Inherited from AccountMultisig.setRequest
- Defined in packages/accounts/src/account_multisig.ts:182

signAndSendTransaction

signAndSendTransaction(__namedParameters): Promise<FinalExecutionOutcome>
Sign a transaction to preform a list of actions and broadcast it using the RPC API.
Parameters
- __namedParameters: SignAndSendTransactionOptions
Returns Promise<FinalExecutionOutcome>
See
JsonRpcProvider.sendTransaction
Overrides AccountMultisig.signAndSendTransaction
- Defined in packages/accounts/src/account_2fa.ts:51

signAndSendTransactionWithAccount

signAndSendTransactionWithAccount(receiverId, actions): Promise<FinalExecutionOutcome>
Parameters
- receiverId: string
- actions: Action[]
Returns Promise<FinalExecutionOutcome>
Inherited from AccountMultisig.signAndSendTransactionWithAccount
- Defined in packages/accounts/src/account_multisig.ts:38

`Protected` signTransaction

signTransaction(receiverId, actions): Promise<[Uint8Array, SignedTransaction]>
Create a signed transaction which can be broadcast to the network
Parameters
- receiverId: string
  NEAR account receiving the transaction
- actions: Action[]
  list of actions to perform as part of the transaction
Returns Promise<[Uint8Array, SignedTransaction]>
See
JsonRpcProvider.sendTransaction
Inherited from AccountMultisig.signTransaction
- Defined in packages/accounts/src/account.ts:195

signatureFor

signatureFor(): Promise<{
blockNumber: string;
blockNumberSignature: string;
}>
Returns Promise<{
blockNumber: string;
blockNumberSignature: string;
}>
- Defined in packages/accounts/src/account_2fa.ts:261

signedDelegate

signedDelegate(__namedParameters): Promise<SignedDelegate>
Compose and sign a SignedDelegate action to be executed in a transaction on behalf of this Account instance
Parameters
- __namedParameters: SignedDelegateOptions
Returns Promise<SignedDelegate>
Inherited from AccountMultisig.signedDelegate
- Defined in packages/accounts/src/account.ts:470

stake

stake(publicKey, amount): Promise<FinalExecutionOutcome>
Parameters
- publicKey: string | PublicKey
  The public key for the account that's staking
- amount: BN
  The account to stake in yoctoⓃ
Returns Promise<FinalExecutionOutcome>
See
https://near-nodes.io/validator/staking-and-delegation
Inherited from AccountMultisig.stake
- Defined in packages/accounts/src/account.ts:456

state

state(): Promise<AccountView>
Returns basic NEAR account information via the view_account RPC query method

Returns Promise<AccountView>
See
https://docs.near.org/api/rpc/contracts#view-account
Inherited from AccountMultisig.state
- Defined in packages/accounts/src/account.ts:181

verifyCodeDefault

verifyCodeDefault(securityCode): Promise<any>
Parameters
- securityCode: string
Returns Promise<any>
- Defined in packages/accounts/src/account_2fa.ts:229

viewFunction

viewFunction(__namedParameters): Promise<any>
Invoke a contract view function using the RPC API.
Parameters
- __namedParameters: ViewFunctionCallOptions
Returns Promise<any>
See
https://docs.near.org/api/rpc/contracts#call-a-contract-function
Inherited from AccountMultisig.viewFunction
- Defined in packages/accounts/src/account.ts:532

viewState

viewState(prefix, blockQuery?): Promise<{
key: Buffer;
value: Buffer;
}[]>
Returns the state (key value pairs) of this account's contract based on the key prefix. Pass an empty string for prefix if you would like to return the entire state.
Parameters
- prefix: string | Uint8Array
  allows to filter which keys should be returned. Empty prefix means all keys. String prefix is utf-8 encoded.
- blockQuery: BlockReference = ...
  specifies which block to query state at. By default returns last "optimistic" block (i.e. not necessarily finalized).
Returns Promise<{
key: Buffer;
value: Buffer;
}[]>
See
https://docs.near.org/api/rpc/contracts#view-contract-state
Inherited from AccountMultisig.viewState
- Defined in packages/accounts/src/account.ts:574

Class Account2FA

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

connection: Connection

accountId: string

options: any

Returns Account2FA

Properties

Readonly accountId

Readonly connection

getCode

helperUrl

onAddRequestResult

Type declaration

Parameters

any: any

Returns any

onConfirmResult

Type declaration

Parameters

any: any

Returns any

sendCode

storage

verifyCode

Methods

addKey

Parameters

publicKey: string | PublicKey

Optional contractId: string

Optional methodNames: string | string[]

Optional amount: BN

Returns Promise<FinalExecutionOutcome>

See

Todo

checkMultisigCodeAndStateStatus

Parameters

Optional contractBytes: Uint8Array

Returns Promise<{ codeStatus: MultisigCodeStatus; stateStatus: MultisigStateStatus; }>

createAccount

Parameters

newAccountId: string

publicKey: string | PublicKey

amount: BN

Returns Promise<FinalExecutionOutcome>

createAndDeployContract

Parameters

contractId: string

publicKey: string | PublicKey

data: Uint8Array

amount: BN

Returns Promise<Account>

deleteAccount

Parameters

beneficiaryId: string

Returns Promise<FinalExecutionOutcome>

deleteAllRequests

Returns Promise<void>

deleteKey

Parameters

publicKey: string | PublicKey

Returns Promise<FinalExecutionOutcome>

deleteRequest

Parameters

request_id: any

Returns Promise<FinalExecutionOutcome>

deleteUnconfirmedRequests

Returns Promise<void>

deployContract

Parameters

data: Uint8Array

Returns Promise<FinalExecutionOutcome>

deployMultisig

Parameters

`Readonly` accountId

`Readonly` connection

`Optional` contractId: string

`Optional` methodNames: string | string[]

`Optional` amount: BN

`Optional` contractBytes: Uint8Array

Returns Promise<{
codeStatus: MultisigCodeStatus;
stateStatus: MultisigStateStatus;
}>

`Optional` contractBytes: Uint8Array

`Optional` cleanupContractBytes: Uint8Array

__namedParameters: {
cleanupContractBytes?: Uint8Array;
contractBytes: Uint8Array;
}

`Optional` cleanupContractBytes?: Uint8Array

Returns Promise<{
accessKey: AccessKeyView;
publicKey: PublicKey;
}>

Returns Promise<{
detail: any;
kind: any;
}>

Returns Promise<{
authorizedApps: AccountAuthorizedApp[];
}>

Returns Promise<{
accountId: string;
data: any;
}>