UNPKG

@astonic-io/astonic-sdk

Version:

Official SDK for interacting with the Astonic Protocol

github.com/astonic-io/astonic-sdk

astonic-io/astonic-sdk

61 lines (60 loc) • 3.1 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
import { BigNumberish, providers, Signer } from 'ethers'; import { Address } from './interfaces'; /** * Gets the chain ID from a signer or provider * @param signerOrProvider an ethers provider or signer * @returns the chain ID */ export declare function getChainId(signerOrProvider: Signer | providers.Provider): Promise<number>; /** * Ensures that given signer is truly a a connected signer * @param signer an ethers signer * @throws if signer is invalid or not connected */ export declare function validateSigner(signer: Signer): void; /** * Ensures that given signerOrProvider is truly a provider or a connected signer * @param signerOrProvider an ethers provider or signer * @throws if signerOrProvider is invalid or not connected */ export declare function validateSignerOrProvider(signerOrProvider: Signer | providers.Provider): void; /** * Returns the broker address from the Planq registry * @param signerOrProvider an ethers provider or signer * @returns the broker address */ export declare function getBrokerAddressFromRegistry(signerOrProvider: Signer | providers.Provider): Promise<Address>; /** * Returns the symbol of an erc20 token * @param tokenAddr the address of the erc20 token * @param signerOrProvider an ethers provider or signer * @returns the symbol of the erc20 token */ export declare function getSymbolFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<string>; /** * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount * @param tokenAddr the address of the erc20 token * @param spender the address of the spender * @param amount the amount to increase the allowance by * @param signerOrProvider an ethers signer or provider * @returns the populated TransactionRequest object */ export declare function increaseAllowance(tokenAddr: string, spender: string, amount: BigNumberish, signerOrProvider: Signer | providers.Provider): Promise<providers.TransactionRequest>; /** * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount * @param tokenAddr the address of the erc20 token * @param spender the address of the spender * @param amount the amount to increase the allowance by * @param signerOrProvider an ethers signer or provider * @returns the populated TransactionRequest object */ export declare function wrap(tokenAddr: string, amount: BigNumberish, signerOrProvider: Signer | providers.Provider): Promise<providers.TransactionRequest>; /** * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount * @param tokenAddr the address of the erc20 token * @param spender the address of the spender * @param amount the amount to increase the allowance by * @param signerOrProvider an ethers signer or provider * @returns the populated TransactionRequest object */ export declare function unwrap(tokenAddr: string, amount: BigNumberish, signerOrProvider: Signer | providers.Provider): Promise<providers.TransactionRequest>;