Class: ProviderRpcClient ​

Table of contents ​

Constructors ​

• constructor

Properties ​

• Contract
• Subscriber

Accessors ​

• isInitialized
• raw
• rawApi

Methods ​

• createContract
• createSubscriber
• hasProvider
• ensureInitialized
• requestPermissions
• changeAccount
• disconnect
• subscribe
• getProviderState
• getBalance
• getFullContractState
• getAccountsByCodeHash
• getExpectedAddress
• getStateInit
• unpackInitData
• packIntoCell
• unpackFromCell
• extractPublicKey
• codeToTvc
• mergeTvc
• splitTvc
• setCodeSalt
• getCodeSalt
• addAsset
• getTransactions
• getTransaction
• sendMessage
• sendMessageDelayed
• getBocHash
• verifySignature
• signData
• signDataRaw
• encryptData
• decryptData

Constructors ​

constructor ​

• new ProviderRpcClient(properties?)

Parameters ​

Defined in ​

src/index.ts:168

Properties ​

Contract ​

• Contract: <Abi>(abi: Abi, address: Address) => Contract<Abi>

Type declaration ​

• new Contract<Abi>(abi, address)

Type parameters ​

Parameters ​

Defined in ​

src/index.ts:165

Subscriber ​

• Subscriber: () => Subscriber

Type declaration ​

• new Subscriber()

Defined in ​

src/index.ts:166

Accessors ​

isInitialized ​

• get isInitialized(): boolean

Whether provider api is ready

Returns ​

boolean

Defined in ​

src/index.ts:311

raw ​

• get raw(): Provider

Raw provider

Returns ​

Provider

Defined in ​

src/index.ts:318

rawApi ​

• get rawApi(): RawProviderApiMethods

Raw provider api

Returns ​

RawProviderApiMethods

Defined in ​

src/index.ts:329

Methods ​

createContract ​

▸ createContract<Abi>(abi, address): Contract<Abi>

Creates typed contract wrapper.

Deprecated

new ever.Contract(abi, address) should be used instead

Sub Category

Factory methods

Type parameters ​

Parameters ​

Returns ​

Contract<Abi>

Defined in ​

src/index.ts:270

createSubscriber ​

▸ createSubscriber(): Subscriber

Creates subscriptions group

Deprecated

new ever.Subscriber() should be used instead

Returns ​

Subscriber

Defined in ​

src/index.ts:279

hasProvider ​

▸ hasProvider(): Promise<boolean>

Checks whether this page has injected Everscale provider or there is a fallback provider.

Sub Category

Initialization and provider related methods

Returns ​

Promise<boolean>

Defined in ​

src/index.ts:289

ensureInitialized ​

▸ ensureInitialized(): Promise<void>

Waits until provider api will be available. Calls fallback if no provider was found

Throws

ProviderNotFoundException when no provider found

Returns ​

Promise<void>

Defined in ​

src/index.ts:301

requestPermissions ​

▸ requestPermissions(args): Promise<Partial<Permissions<Address>>>

Requests new permissions for current origin. Shows an approval window to the user. Will overwrite already existing permissions

Required permissions: none

Sub Category

Account and Permissions management

Parameters ​

Returns ​

Promise<Partial<Permissions<Address>>>

Defined in ​

src/index.ts:343

changeAccount ​

▸ changeAccount(): Promise<void>

Updates accountInteraction permission value

Requires permissions: accountInteraction

Returns ​

Promise<void>

Defined in ​

src/index.ts:359

disconnect ​

▸ disconnect(): Promise<void>

Removes all permissions for current origin and stops all subscriptions

Returns ​

Promise<void>

Defined in ​

src/index.ts:367

subscribe ​

▸ subscribe(eventName, params): Promise<Subscription<"contractStateChanged">>

Called every time contract state changes

Sub Category

Subscription management

Parameters ​

Returns ​

Promise<Subscription<"contractStateChanged">>

Defined in ​

src/index.ts:377

▸ subscribe(eventName, params): Promise<Subscription<"transactionsFound">>

Called on each new transactions batch, received on subscription

Parameters ​

Returns ​

Promise<Subscription<"transactionsFound">>

Defined in ​

src/index.ts:385

▸ subscribe(eventName): Promise<Subscription<"connected">>

Called every time when provider connection is established

Parameters ​

Returns ​

Promise<Subscription<"connected">>

Defined in ​

src/index.ts:393

▸ subscribe(eventName): Promise<Subscription<"disconnected">>

Called when inpage provider disconnects from extension

Parameters ​

Returns ​

Promise<Subscription<"disconnected">>

Defined in ​

src/index.ts:398

▸ subscribe(eventName): Promise<Subscription<"messageStatusUpdated">>

Called every time a delayed message was delivered or expired

Parameters ​

Returns ​

Promise<Subscription<"messageStatusUpdated">>

Defined in ​

src/index.ts:403

▸ subscribe(eventName): Promise<Subscription<"networkChanged">>

Called each time the user changes network

Parameters ​

Returns ​

Promise<Subscription<"networkChanged">>

Defined in ​

src/index.ts:408

▸ subscribe(eventName): Promise<Subscription<"permissionsChanged">>

Called when permissions are changed. Mostly when account has been removed from the current accountInteraction permission, or disconnect method was called

Parameters ​

Returns ​

Promise<Subscription<"permissionsChanged">>

Defined in ​

src/index.ts:415

▸ subscribe(eventName): Promise<Subscription<"loggedOut">>

Called when the user logs out of the extension

Parameters ​

Returns ​

Promise<Subscription<"loggedOut">>

Defined in ​

src/index.ts:420

getProviderState ​

▸ getProviderState(): Promise<{ version: string ; numericVersion: number ; selectedConnection: string ; networkId: number ; supportedPermissions: keyof Permissions<Address>[] ; permissions: Partial<Permissions<Address>> ; subscriptions: { [address: string]: ContractUpdatesSubscription; } }>

Returns provider api state

Required permissions: none

Sub Category

Contract & Data Handling

Returns ​

Promise<{ version: string ; numericVersion: number ; selectedConnection: string ; networkId: number ; supportedPermissions: keyof Permissions<Address>[] ; permissions: Partial<Permissions<Address>> ; subscriptions: { [address: string]: ContractUpdatesSubscription; } }>

Defined in ​

src/index.ts:591

getBalance ​

▸ getBalance(address): Promise<string>

Requests contract balance

Required permissions: basic

Parameters ​

Returns ​

Promise<string>

Defined in ​

src/index.ts:606

getFullContractState ​

▸ getFullContractState(args): Promise<{ state: undefined | FullContractState }>

Requests contract data

Required permissions: basic

Parameters ​

Returns ​

Promise<{ state: undefined | FullContractState }>

Defined in ​

src/index.ts:619

getAccountsByCodeHash ​

▸ getAccountsByCodeHash(args): Promise<{ accounts: Address[] ; continuation: undefined | string }>

Requests accounts with specified code hash

Required permissions: basic

Parameters ​

Returns ​

Promise<{ accounts: Address[] ; continuation: undefined | string }>

Defined in ​

src/index.ts:634

getExpectedAddress ​

▸ getExpectedAddress<Abi>(abi, args): Promise<Address>

Computes contract address from code and init params

Required permissions: basic

Type parameters ​

Parameters ​

Returns ​

Promise<Address>

Defined in ​

src/index.ts:653

getStateInit ​

▸ getStateInit<Abi>(abi, args): Promise<{ address: Address ; stateInit: string ; hash: string }>

Computes contract address and state from code and init params

Required permissions: basic

Type parameters ​

Parameters ​

Returns ​

Promise<{ address: Address ; stateInit: string ; hash: string }>

Defined in ​

src/index.ts:664

unpackInitData ​

▸ unpackInitData<Abi>(abi, data): Promise<{ publicKey?: string ; initParams: DecodedAbiInitData<Abi> }>

Decodes initial contract data using the specified ABI

Required permissions: basic

Type parameters ​

Parameters ​

Returns ​

Promise<{ publicKey?: string ; initParams: DecodedAbiInitData<Abi> }>

Defined in ​

src/index.ts:687

packIntoCell ​

▸ packIntoCell<P>(args): Promise<{ boc: string ; hash: string }>

Creates base64 encoded BOC

Required permissions: basic

Type parameters ​

Parameters ​

Returns ​

Promise<{ boc: string ; hash: string }>

Defined in ​

src/index.ts:708

unpackFromCell ​

▸ unpackFromCell<P>(args): Promise<{ data: MergeOutputObjectsArray<P> }>

Decodes base64 encoded BOC

Required permissions: basic

Type parameters ​

Parameters ​

Returns ​

Promise<{ data: MergeOutputObjectsArray<P> }>

Defined in ​

src/index.ts:727

extractPublicKey ​

▸ extractPublicKey(boc): Promise<string>

Extracts public key from raw account state

NOTE: can only be used on contracts which are deployed and has pubkey header

Required permissions: basic

Parameters ​

Returns ​

Promise<string>

Defined in ​

src/index.ts:751

codeToTvc ​

▸ codeToTvc(code): Promise<string>

Converts base64 encoded contract code into tvc with default init data

Required permissions: basic

Parameters ​

Returns ​

Promise<string>

Defined in ​

src/index.ts:765

mergeTvc ​

▸ mergeTvc(args): Promise<{ tvc: string ; hash: string }>

Merges code and data into state init

Required permissions: basic

Parameters ​

Returns ​

Promise<{ tvc: string ; hash: string }>

Defined in ​

src/index.ts:779

splitTvc ​

▸ splitTvc(tvc): Promise<{ data: undefined | string ; code: undefined | string }>

Splits base64 encoded state init into code and data

Required permissions: basic

Parameters ​

Returns ​

Promise<{ data: undefined | string ; code: undefined | string }>

Defined in ​

src/index.ts:790

setCodeSalt ​

▸ setCodeSalt<P>(args): Promise<{ code: string ; hash: string }>

Merges code and data into state init

Required permissions: basic

Type parameters ​

Parameters ​

Returns ​

Promise<{ code: string ; hash: string }>

Defined in ​

src/index.ts:803

getCodeSalt ​

▸ getCodeSalt(args): Promise<undefined | string>

Retrieves salt from code. Returns undefined if code doesn't contain salt

Required permissions: basic

Parameters ​

Returns ​

Promise<undefined | string>

Defined in ​

src/index.ts:823

addAsset ​

▸ addAsset<T>(args): Promise<{ newAsset: boolean }>

Adds asset to the selected account

Requires permissions: accountInteraction

Type parameters ​

Parameters ​

Returns ​

Promise<{ newAsset: boolean }>

Defined in ​

src/index.ts:837

getTransactions ​

▸ getTransactions(args): Promise<{ transactions: Transaction<Address>[] ; continuation: undefined | TransactionId ; info?: TransactionsBatchInfo }>

Requests contract transactions

Required permissions: basic

Sub Category

Transactions

Parameters ​

Returns ​

Promise<{ transactions: Transaction<Address>[] ; continuation: undefined | TransactionId ; info?: TransactionsBatchInfo }>

Defined in ​

src/index.ts:866

getTransaction ​

▸ getTransaction(args): Promise<{ transaction: undefined | Transaction<Address> }>

Searches transaction by hash

Required permissions: basic

Parameters ​

Returns ​

Promise<{ transaction: undefined | Transaction<Address> }>

Defined in ​

src/index.ts:887

sendMessage ​

▸ sendMessage(args): Promise<{ transaction: Transaction<Address> }>

Sends an internal message from the user account. Shows an approval window to the user.

Required permissions: accountInteraction

Parameters ​

Returns ​

Promise<{ transaction: Transaction<Address> }>

Defined in ​

src/index.ts:906

sendMessageDelayed ​

▸ sendMessageDelayed(args): Promise<DelayedMessageExecution>

Sends an internal message from the user account without waiting for the transaction. Shows an approval window to the user.

See

messageStatusUpdated

Required permissions: accountInteraction

Parameters ​

Returns ​

Promise<DelayedMessageExecution>

Defined in ​

src/index.ts:936

getBocHash ​

▸ getBocHash(boc): Promise<string>

Computes hash of base64 encoded BOC

Required permissions: basic

Sub Category

Cryptography & Security

Parameters ​

Returns ​

Promise<string>

Defined in ​

src/index.ts:1026

verifySignature ​

▸ verifySignature(args): Promise<{ isValid: boolean }>

Parameters ​

Returns ​

Promise<{ isValid: boolean }>

Defined in ​

src/index.ts:1035

signData ​

▸ signData(args): Promise<{ dataHash: string ; signature: string ; signatureHex: string ; signatureParts: { high: string ; low: string } }>

Signs arbitrary data.

NOTE: hashes data before signing. Use signDataRaw to sign without hash.

Requires permissions: accountInteraction

Parameters ​

Returns ​

Promise<{ dataHash: string ; signature: string ; signatureHex: string ; signatureParts: { high: string ; low: string } }>

Defined in ​

src/index.ts:1050

signDataRaw ​

▸ signDataRaw(args): Promise<{ signature: string ; signatureHex: string ; signatureParts: { high: string ; low: string } }>

Signs arbitrary data without hashing it

Requires permissions: accountInteraction

Parameters ​

Returns ​

Promise<{ signature: string ; signatureHex: string ; signatureParts: { high: string ; low: string } }>

Defined in ​

src/index.ts:1061

encryptData ​

▸ encryptData(args): Promise<EncryptedData[]>

Encrypts arbitrary data with specified algorithm for each specified recipient

Requires permissions: accountInteraction

Parameters ​

Returns ​

Promise<EncryptedData[]>

Defined in ​

src/index.ts:1072

decryptData ​

▸ decryptData(encryptedData): Promise<string>

Decrypts encrypted data. Returns base64 encoded data

Requires permissions: accountInteraction

Parameters ​

Returns ​

Promise<string>

Defined in ​

src/index.ts:1084