Class ProviderRpcClient

Hierarchy

ProviderRpcClient

Properties

Contract

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

Type declaration

- new <Abi>(abi: Abi, address: Address): Contract<Abi>
- Type Parameters
 - Abi
 Parameters
 - abi: Abi
 - address: Address
 Returns Contract<Abi>

Subscriber

Subscriber: (new () => Subscriber)

Type declaration

- new (): Subscriber
- Returns Subscriber

Constructors

constructor

new ProviderRpcClient(properties?: ProviderProperties): ProviderRpcClient
Parameters
- properties: ProviderProperties = {}
Returns ProviderRpcClient
- Defined in src/index.ts:143

Methods

hasProvider

hasProvider(): Promise<boolean>
Checks whether this page has injected Everscale provider or there is a fallback provider.

Returns Promise<boolean>
- Defined in src/index.ts:239

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:251

createContract

createContract<Abi>(abi: Abi, address: Address): Contract<Abi>
Creates typed contract wrapper.

Deprecated
new ever.Contract(abi, address) should be used instead
Type Parameters
- Abi
Parameters
- abi: Abi
 
 Readonly object (must be declared with as const)
- address: Address
 
 Default contract address
Returns Contract<Abi>
- Defined in src/index.ts:291

createSubscriber

createSubscriber(): Subscriber
Creates subscriptions group

Deprecated
new ever.Subscriber() should be used instead

Returns Subscriber
- Defined in src/index.ts:300

requestPermissions

requestPermissions(args: {
permissions: (keyof Permissions<Address>)[];
}): 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
Parameters
- args: {
 permissions: (keyof Permissions<Address>)[];
 }
 - permissions: (keyof Permissions<Address>)[]
Returns Promise<Partial<Permissions<Address>>>
- Defined in src/index.ts:312

changeAccount

changeAccount(): Promise<void>
Updates accountInteraction permission value

Requires permissions: accountInteraction

Returns Promise<void>
- Defined in src/index.ts:328

disconnect

disconnect(): Promise<void>
Removes all permissions for current origin and stops all subscriptions

Returns Promise<void>
- Defined in src/index.ts:336

subscribe(eventName: "contractStateChanged", params: {
address: Address;
}): Promise<Subscription<"contractStateChanged">>
Called every time contract state changes
Parameters
- eventName: "contractStateChanged"
- params: {
 address: Address;
 }
 - address: Address
Returns Promise<Subscription<"contractStateChanged">>
- Defined in src/index.ts:344
subscribe(eventName: "transactionsFound", params: {
address: Address;
}): Promise<Subscription<"transactionsFound">>
Called on each new transactions batch, received on subscription
Parameters
- eventName: "transactionsFound"
- params: {
 address: Address;
 }
 - address: Address
Returns Promise<Subscription<"transactionsFound">>
- Defined in src/index.ts:352
subscribe(eventName: "connected"): Promise<Subscription<"connected">>
Called every time when provider connection is established
Parameters
- eventName: "connected"
Returns Promise<Subscription<"connected">>
- Defined in src/index.ts:360
subscribe(eventName: "disconnected"): Promise<Subscription<"disconnected">>
Called when inpage provider disconnects from extension
Parameters
- eventName: "disconnected"
Returns Promise<Subscription<"disconnected">>
- Defined in src/index.ts:365
subscribe(eventName: "messageStatusUpdated"): Promise<Subscription<"messageStatusUpdated">>
Called every time a delayed message was delivered or expired
Parameters
- eventName: "messageStatusUpdated"
Returns Promise<Subscription<"messageStatusUpdated">>
- Defined in src/index.ts:370
subscribe(eventName: "networkChanged"): Promise<Subscription<"networkChanged">>
Called each time the user changes network
Parameters
- eventName: "networkChanged"
Returns Promise<Subscription<"networkChanged">>
- Defined in src/index.ts:375
subscribe(eventName: "permissionsChanged"): 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
- eventName: "permissionsChanged"
Returns Promise<Subscription<"permissionsChanged">>
- Defined in src/index.ts:382
subscribe(eventName: "loggedOut"): Promise<Subscription<"loggedOut">>
Called when the user logs out of the extension
Parameters
- eventName: "loggedOut"
Returns Promise<Subscription<"loggedOut">>
- Defined in src/index.ts:387

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

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:555

getBalance

getBalance(address: Address): Promise<string>
Requests contract balance

Required permissions: basic
Parameters
- address: Address
Returns Promise<string>
- Defined in src/index.ts:570

getFullContractState

getFullContractState(args: {
address: Address;
}): Promise<{
state: undefined | FullContractState;
}>
Requests contract data

Required permissions: basic
Parameters
- args: {
 address: Address;
 }
 - address: Address
 
 Contract address
Returns Promise<{
state: undefined | FullContractState;
}>
- Defined in src/index.ts:583

computeStorageFee

computeStorageFee(args: {
 state: FullContractState;
 masterchain?: boolean;
 timestamp?: number;
}): Promise<{
 storageFee: string;
 storageFeeDebt?: string;
 accountStatus: AccountStatus;
 freezeDueLimit: string;
 deleteDueLimit: string;
}>
Compute storage fee

Required permissions: basic
Parameters
- args: {
 state: FullContractState;
 masterchain?: boolean;
 timestamp?: number;
 }
 - state: FullContractState
 
 Existing contract state
 - Optional masterchain?: boolean
 
 Whether to assume that the contract is in the masterchain. Default: false
 - Optional timestamp?: number
 
 Optional UNIX timestamp (in seconds) of the moment up to which the storage fee is calculated. Default: current timestamp
 
 NOTE: for a time that was earlier than the last state update, the last_paid time will be used.
Returns Promise<{
 storageFee: string;
 storageFeeDebt?: string;
 accountStatus: AccountStatus;
 freezeDueLimit: string;
 deleteDueLimit: string;
}>
- Defined in src/index.ts:598

getAccountsByCodeHash

getAccountsByCodeHash(args: {
 codeHash: string;
 continuation?: string;
 limit?: number;
}): Promise<{
 accounts: Address[];
 continuation: undefined | string;
}>
Requests accounts with specified code hash

Required permissions: basic
Parameters
- args: {
 codeHash: string;
 continuation?: string;
 limit?: number;
 }
 - codeHash: string
 
 Hex encoded code hash
 - Optional continuation?: string
 
 Last address from previous batch
 - Optional limit?: number
 
 Optional limit. Values grater than 50 have no effect
Returns Promise<{
accounts: Address[];
continuation: undefined | string;
}>
- Defined in src/index.ts:624

getTransactions

getTransactions(args: {
 address: Address;
 continuation?: TransactionId;
 limit?: number;
}): Promise<{
 transactions: Transaction<Address>[];
 continuation: undefined | TransactionId;
 info?: TransactionsBatchInfo;
}>
Requests contract transactions

Required permissions: basic
Parameters
- args: {
 address: Address;
 continuation?: TransactionId;
 limit?: number;
 }
 - address: Address
 
 Contract address
 - Optional continuation?: TransactionId
 
 Id of the transaction from which to request the next batch
 - Optional limit?: number
 
 Optional limit. Values greater than 50 have no effect
Returns Promise<{
 transactions: Transaction<Address>[];
 continuation: undefined | TransactionId;
 info?: TransactionsBatchInfo;
}>
- Defined in src/index.ts:643

getTransaction

getTransaction(args: {
hash: string;
}): Promise<{
transaction: undefined | Transaction<Address>;
}>
Searches transaction by hash

Required permissions: basic
Parameters
- args: {
 hash: string;
 }
 - hash: string
 
 Hex encoded transaction hash
Returns Promise<{
transaction: undefined | Transaction<Address>;
}>
- Defined in src/index.ts:664

getExpectedAddress

getExpectedAddress<Abi>(abi: Abi, args: GetExpectedAddressParams<Abi>): Promise<Address>
Computes contract address from code and init params

Required permissions: basic
Type Parameters
- Abi
Parameters
- abi: Abi
- args: GetExpectedAddressParams<Abi>
Returns Promise<Address>
- Defined in src/index.ts:682

getStateInit

getStateInit<Abi>(abi: Abi, args: GetExpectedAddressParams<Abi>): Promise<{
 address: Address;
 stateInit: string;
 hash: string;
}>
Computes contract address and state from code and init params

Required permissions: basic
Type Parameters
- Abi
Parameters
- abi: Abi
- args: GetExpectedAddressParams<Abi>
Returns Promise<{
 address: Address;
 stateInit: string;
 hash: string;
}>
- Defined in src/index.ts:693

unpackInitData

unpackInitData<Abi>(abi: Abi, data: string): Promise<{
publicKey?: string;
initParams: DecodedAbiInitData<Abi>;
}>
Decodes initial contract data using the specified ABI

Required permissions: basic
Type Parameters
- Abi
Parameters
- abi: Abi
- data: string
Returns Promise<{
publicKey?: string;
initParams: DecodedAbiInitData<Abi>;
}>
- Defined in src/index.ts:716

getBocHash

getBocHash(boc: string): Promise<string>
Computes hash of base64 encoded BOC

Required permissions: basic
Parameters
- boc: string
Returns Promise<string>
- Defined in src/index.ts:740

packIntoCell

packIntoCell(args: {
 abiVersion?: AbiVersion;
 structure: P;
 data: MergeInputObjectsArray;
}): Promise<{
 boc: string;
 hash: string;
}>
Creates base64 encoded BOC

Required permissions: basic
Type Parameters
- P extends readonly ReadonlyAbiParam[]
Parameters
- args: {
 abiVersion?: AbiVersion;
 structure: P;
 data: MergeInputObjectsArray;
 }
 - Optional abiVersion?: AbiVersion
 - structure: P
 - data: MergeInputObjectsArray
Returns Promise<{
boc: string;
hash: string;
}>
- Defined in src/index.ts:755

unpackFromCell

unpackFromCell(args: {
 abiVersion?: AbiVersion;
 structure: P;
 boc: string;
 allowPartial: boolean;
}): Promise<{
 data: MergeOutputObjectsArray;
}>
Decodes base64 encoded BOC

Required permissions: basic
Type Parameters
- P extends readonly ReadonlyAbiParam[]
Parameters
- args: {
 abiVersion?: AbiVersion;
 structure: P;
 boc: string;
 allowPartial: boolean;
 }
 - Optional abiVersion?: AbiVersion
 - structure: P
 - boc: string
 - allowPartial: boolean
Returns Promise<{
data: MergeOutputObjectsArray;
}>
- Defined in src/index.ts:774

extractPublicKey

extractPublicKey(boc: string): 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
- boc: string
Returns Promise<string>
- Defined in src/index.ts:798

codeToTvc

codeToTvc(code: string): Promise<string>
Converts base64 encoded contract code into tvc with default init data

Required permissions: basic
Parameters
- code: string
Returns Promise<string>
- Defined in src/index.ts:812

mergeTvc

mergeTvc(args: {
 code: string;
 data: string;
}): Promise<{
 tvc: string;
 hash: string;
}>
Merges code and data into state init

Required permissions: basic
Parameters
- args: {
 code: string;
 data: string;
 }
 - code: string
 
 Base64 encoded contract code
 - data: string
 
 Base64 encoded contract data
Returns Promise<{
tvc: string;
hash: string;
}>
- Defined in src/index.ts:826

splitTvc

splitTvc(tvc: string): Promise<{
data: undefined | string;
code: undefined | string;
}>
Splits base64 encoded state init into code and data

Required permissions: basic
Parameters
- tvc: string
Returns Promise<{
data: undefined | string;
code: undefined | string;
}>
- Defined in src/index.ts:837

setCodeSalt

setCodeSalt(args: SetCodeSaltParams): Promise<{
code: string;
hash: string;
}>
Merges code and data into state init

Required permissions: basic
Type Parameters
- P extends readonly ReadonlyAbiParam[]
Parameters
- args: SetCodeSaltParams
Returns Promise<{
code: string;
hash: string;
}>
- Defined in src/index.ts:850

getCodeSalt

getCodeSalt(args: GetCodeSaltParams): Promise<undefined | string>
Retrieves salt from code. Returns undefined if code doesn't contain salt

Required permissions: basic
Parameters
- args: GetCodeSaltParams
Returns Promise<undefined | string>
- Defined in src/index.ts:870

addAsset

addAsset<T>(args: AddAssetParams<T>): Promise<{
newAsset: boolean;
}>
Adds asset to the selected account

Requires permissions: accountInteraction
Type Parameters
- T extends "tip3_token"
Parameters
- args: AddAssetParams<T>
Returns Promise<{
newAsset: boolean;
}>
- Defined in src/index.ts:884

verifySignature

verifySignature(args: {
 publicKey: string;
 dataHash: string;
 signature: string;
 withSignatureId?: number | boolean;
}): Promise<{
 isValid: boolean;
}>
Parameters
- args: {
 publicKey: string;
 dataHash: string;
 signature: string;
 withSignatureId?: number | boolean;
 }
 - publicKey: string
 
 The public key of the preferred account. It is the same publicKey as the accountInteraction.publicKey, but it must be explicitly provided
 - dataHash: string
 
 Base64 or hex encoded arbitrary bytes hash (data must be 32 bytes long)
 - signature: string
 
 Base64 or hex encoded signature bytes (data must be 64 bytes long)
 - Optional withSignatureId?: number | boolean
 Whether to use the signature id during verification (true by default).
 
 If true, uses the signature id of the selected network (if the capability is enabled).
 
 If false, forces signature check to ignore any signature id.
 
 If number, uses the specified number as a signature id.
Returns Promise<{
isValid: boolean;
}>
- Defined in src/index.ts:905

signData

signData(args: {
 publicKey: string;
 data: string;
 withSignatureId?: number | boolean;
}): 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
- args: {
 publicKey: string;
 data: string;
 withSignatureId?: number | boolean;
 }
 - publicKey: string
 
 The public key of the preferred account. It is the same publicKey as the accountInteraction.publicKey, but it must be explicitly provided
 - data: string
 
 Base64 encoded arbitrary bytes
 - Optional withSignatureId?: number | boolean
 Whether to use the signature id for signing (true by default).
 
 If true, uses the signature id of the selected network (if the capability is enabled).
 
 If false, forces signature check to ignore any signature id.
 
 If number, uses the specified number as a signature id.
Returns Promise<{
 dataHash: string;
 signature: string;
 signatureHex: string;
 signatureParts: {
 high: string;
 low: string;
 };
}>
- Defined in src/index.ts:920

signDataRaw

signDataRaw(args: {
 publicKey: string;
 data: string;
 withSignatureId?: number | boolean;
}): Promise<{
 signature: string;
 signatureHex: string;
 signatureParts: {
 high: string;
 low: string;
 };
}>
Signs arbitrary data without hashing it

Requires permissions: accountInteraction
Parameters
- args: {
 publicKey: string;
 data: string;
 withSignatureId?: number | boolean;
 }
 - publicKey: string
 
 The public key of the preferred account. It is the same publicKey as the accountInteraction.publicKey, but it must be explicitly provided
 - data: string
 
 Base64 encoded arbitrary bytes
 - Optional withSignatureId?: number | boolean
 Whether to use the signature id for signing (true by default).
 
 If true, uses the signature id of the selected network (if the capability is enabled).
 
 If false, forces signature check to ignore any signature id.
 
 If number, uses the specified number as a signature id.
Returns Promise<{
 signature: string;
 signatureHex: string;
 signatureParts: {
 high: string;
 low: string;
 };
}>
- Defined in src/index.ts:931

encryptData

encryptData(args: {
 publicKey: string;
 recipientPublicKeys: string[];
 algorithm: "ChaCha20Poly1305";
 data: string;
}): Promise<EncryptedData[]>
Encrypts arbitrary data with specified algorithm for each specified recipient

Requires permissions: accountInteraction
Parameters
- args: {
 publicKey: string;
 recipientPublicKeys: string[];
 algorithm: "ChaCha20Poly1305";
 data: string;
 }
 - publicKey: string
 
 The public key of the preferred account. It is the same publicKey as the accountInteraction.publicKey, but it must be explicitly provided
 - recipientPublicKeys: string[]
 
 Public keys of recipients. Hex encoded
 - algorithm: "ChaCha20Poly1305"
 
 Encryption algorithm. Nonce will be generated for each recipient
 - data: string
 
 Base64 encoded data
Returns Promise<EncryptedData[]>
- Defined in src/index.ts:942

decryptData

decryptData(encryptedData: EncryptedData): Promise<string>
Decrypts encrypted data. Returns base64 encoded data

Requires permissions: accountInteraction
Parameters
- encryptedData: EncryptedData
Returns Promise<string>
- Defined in src/index.ts:954

sendMessage

sendMessage(args: {
 sender: Address;
 recipient: Address;
 amount: string;
 bounce: boolean;
 payload?: FunctionCall<Address>;
 stateInit?: string;
}): Promise<{
 transaction: Transaction<Address>;
}>
Sends an internal message from the user account. Shows an approval window to the user.

Required permissions: accountInteraction
Parameters
- args: {
 sender: Address;
 recipient: Address;
 amount: string;
 bounce: boolean;
 payload?: FunctionCall<Address>;
 stateInit?: string;
 }
 - sender: Address
 
 Preferred wallet address. It is the same address as the accountInteraction.address, but it must be explicitly provided
 - recipient: Address
 
 Message destination address
 - amount: string
 
 Amount of nano EVER to send
 - bounce: boolean
 
 Whether to bounce message back on error
 - Optional payload?: FunctionCall<Address>
 
 Optional function call
 - Optional stateInit?: string
 
 Optional base64 encoded TVC
 
 NOTE: If the selected contract do not support this, an error is returned
Returns Promise<{
transaction: Transaction<Address>;
}>
- Defined in src/index.ts:967

sendMessageDelayed

sendMessageDelayed(args: {
 sender: Address;
 recipient: Address;
 amount: string;
 bounce: boolean;
 payload?: FunctionCall<Address>;
 stateInit?: string;
}): 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
- args: {
 sender: Address;
 recipient: Address;
 amount: string;
 bounce: boolean;
 payload?: FunctionCall<Address>;
 stateInit?: string;
 }
 - sender: Address
 
 Preferred wallet address. It is the same address as the accountInteraction.address, but it must be explicitly provided
 - recipient: Address
 
 Message destination address
 - amount: string
 
 Amount of nano EVER to send
 - bounce: boolean
 
 Whether to bounce message back on error
 - Optional payload?: FunctionCall<Address>
 
 Optional function call
 - Optional stateInit?: string
 
 Optional base64 encoded TVC
 
 NOTE: If the selected contract do not support this, an error is returned
Returns Promise<DelayedMessageExecution>
- Defined in src/index.ts:997

Accessors

isInitialized

get isInitialized(): boolean
Whether provider api is ready

Returns boolean
- Defined in src/index.ts:261

raw

get raw(): Provider
Raw provider

Returns Provider
- Defined in src/index.ts:268

rawApi

get rawApi(): RawProviderApiMethods
Raw provider api

Returns RawProviderApiMethods
- Defined in src/index.ts:279

Class ProviderRpcClient

Hierarchy

Index

Properties

Constructors

Methods

Accessors

Properties

Contract

Type declaration

Type Parameters

Abi

Parameters

abi: Abi

address: Address

Returns Contract<Abi>

Subscriber

Type declaration

Returns Subscriber

Constructors

constructor

Parameters

properties: ProviderProperties = {}

Returns ProviderRpcClient

Methods

hasProvider

Returns Promise<boolean>

ensureInitialized

Throws

Returns Promise<void>

createContract

Deprecated

Type Parameters

Abi

Parameters

abi: Abi

address: Address

Returns Contract<Abi>

createSubscriber

Deprecated

Returns Subscriber

requestPermissions

Parameters

args: { permissions: (keyof Permissions<Address>)[]; }

permissions: (keyof Permissions<Address>)[]

Returns Promise<Partial<Permissions<Address>>>

changeAccount

Returns Promise<void>

disconnect

Returns Promise<void>

subscribe

Parameters

eventName: "contractStateChanged"

params: { address: Address; }

address: Address

Returns Promise<Subscription<"contractStateChanged">>

Parameters

eventName: "transactionsFound"

params: { address: Address; }

address: Address

Returns Promise<Subscription<"transactionsFound">>

Parameters

eventName: "connected"

Returns Promise<Subscription<"connected">>

Parameters

eventName: "disconnected"

Returns Promise<Subscription<"disconnected">>

Parameters

eventName: "messageStatusUpdated"

Returns Promise<Subscription<"messageStatusUpdated">>

Parameters

eventName: "networkChanged"

Returns Promise<Subscription<"networkChanged">>

Parameters

eventName: "permissionsChanged"

Returns Promise<Subscription<"permissionsChanged">>

Parameters

eventName: "loggedOut"

Returns Promise<Subscription<"loggedOut">>

getProviderState

args: {
permissions: (keyof Permissions<Address>)[];
}

params: {
address: Address;
}

params: {
address: Address;
}

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

args: {
address: Address;
}

Returns Promise<{
state: undefined | FullContractState;
}>

args: {
state: FullContractState;
masterchain?: boolean;
timestamp?: number;
}

`Optional` masterchain?: boolean

`Optional` timestamp?: number

Returns Promise<{
storageFee: string;
storageFeeDebt?: string;
accountStatus: AccountStatus;
freezeDueLimit: string;
deleteDueLimit: string;
}>

args: {
codeHash: string;
continuation?: string;
limit?: number;
}

`Optional` continuation?: string

`Optional` limit?: number

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

args: {
address: Address;
continuation?: TransactionId;
limit?: number;
}

`Optional` continuation?: TransactionId

`Optional` limit?: number

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

args: {
hash: string;
}

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

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

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

args: {
abiVersion?: AbiVersion;
structure: P;
data: MergeInputObjectsArray<P>;
}

`Optional` abiVersion?: AbiVersion

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