tronwb 6.0.0

package/src/types/Contract.ts

@@ -0,0 +1,352 @@
+import { Resource } from '../types/TransactionBuilder.js';
+import { ContractAbiInterface } from './ABI.js';
+export enum ContractType {
+    AccountCreateContract = 'AccountCreateContract',
+    TransferContract = 'TransferContract',
+    TransferAssetContract = 'TransferAssetContract',
+    VoteAssetContract = 'VoteAssetContract',
+    VoteWitnessContract = 'VoteWitnessContract',
+    WitnessCreateContract = 'WitnessCreateContract',
+    AssetIssueContract = 'AssetIssueContract',
+    WitnessUpdateContract = 'WitnessUpdateContract',
+    ParticipateAssetIssueContract = 'ParticipateAssetIssueContract',
+    AccountUpdateContract = 'AccountUpdateContract',
+    FreezeBalanceContract = 'FreezeBalanceContract',
+    UnfreezeBalanceContract = 'UnfreezeBalanceContract',
+    CancelAllUnfreezeV2Contract = 'CancelAllUnfreezeV2Contract',
+    WithdrawBalanceContract = 'WithdrawBalanceContract',
+    UnfreezeAssetContract = 'UnfreezeAssetContract',
+    UpdateAssetContract = 'UpdateAssetContract',
+    ProposalCreateContract = 'ProposalCreateContract',
+    ProposalApproveContract = 'ProposalApproveContract',
+    ProposalDeleteContract = 'ProposalDeleteContract',
+    SetAccountIdContract = 'SetAccountIdContract',
+    CustomContract = 'CustomContract',
+    CreateSmartContract = 'CreateSmartContract',
+    TriggerSmartContract = 'TriggerSmartContract',
+    GetContract = 'GetContract',
+    UpdateSettingContract = 'UpdateSettingContract',
+    ExchangeCreateContract = 'ExchangeCreateContract',
+    ExchangeInjectContract = 'ExchangeInjectContract',
+    ExchangeWithdrawContract = 'ExchangeWithdrawContract',
+    ExchangeTransactionContract = 'ExchangeTransactionContract',
+    UpdateEnergyLimitContract = 'UpdateEnergyLimitContract',
+    AccountPermissionUpdateContract = 'AccountPermissionUpdateContract',
+    ClearABIContract = 'ClearABIContract',
+    UpdateBrokerageContract = 'UpdateBrokerageContract',
+    ShieldedTransferContract = 'ShieldedTransferContract',
+    MarketSellAssetContract = 'MarketSellAssetContract',
+    MarketCancelOrderContract = 'MarketCancelOrderContract',
+    FreezeBalanceV2Contract = 'FreezeBalanceV2Contract',
+    UnfreezeBalanceV2Contract = 'UnfreezeBalanceV2Contract',
+    WithdrawExpireUnfreezeContract = 'WithdrawExpireUnfreezeContract',
+    DelegateResourceContract = 'DelegateResourceContract',
+    UnDelegateResourceContract = 'UnDelegateResourceContract',
+    UNRECOGNIZED = 'UNRECOGNIZED',
+}
+export enum Permission_PermissionType {
+    Owner = 0,
+    Witness = 1,
+    Active = 2,
+    UNRECOGNIZED = -1,
+}
+
+export interface Key {
+    address: Uint8Array;
+    weight: number;
+}
+
+export enum AccountType {
+    Normal = 0,
+    AssetIssue = 1,
+    Contract = 2,
+    UNRECOGNIZED = -1,
+}
+
+export interface PermissionKey {
+    address: string;
+    weight: number;
+}
+export interface Permission {
+    type: number;
+    /** Owner id=0, Witness id=1, Active id start by 2 */
+    id?: number;
+    permission_name: string;
+    threshold: number;
+    operations?: string;
+    keys: PermissionKey[];
+}
+
+export interface TransferContract {
+    to_address: string;
+    owner_address: string;
+    amount: number;
+}
+
+export interface TransferAssetContract {
+    to_address: string;
+    owner_address: string;
+    amount: number;
+    asset_name: string;
+}
+
+export interface ParticipateAssetIssueContract {
+    to_address: string;
+    owner_address: string;
+    asset_name: string;
+    amount: number;
+}
+
+export interface TriggerSmartContract {
+    owner_address: string;
+    contract_address: string;
+    call_value?: number;
+    call_token_value?: number;
+    token_id?: number;
+    data?: string;
+}
+
+export interface FreezeBalanceContract {
+    owner_address: string;
+    frozen_balance: number;
+    frozen_duration: number;
+    resource?: Resource;
+    receiver_address?: string;
+}
+
+export interface UnfreezeBalanceContract {
+    owner_address: string;
+    resource: string;
+    receiver_address: string;
+}
+
+export interface WithdrawBalanceContract {
+    owner_address: string;
+}
+
+export interface FreezeBalanceV2Contract {
+    owner_address: string;
+    frozen_balance: number;
+    resource?: Resource;
+}
+
+export interface CancelFreezeBalanceV2Contract {
+    owner_address: string;
+}
+
+export interface UnfreezeBalanceV2Contract {
+    owner_address: string;
+    unfreeze_balance: number;
+    resource?: Resource;
+}
+
+export interface DelegateResourceContract {
+    owner_address: string;
+    receiver_address: string;
+    balance: number;
+    resource?: Resource;
+    lock?: boolean;
+    lock_period?: number;
+}
+
+export interface UnDelegateResourceContract {
+    owner_address: string;
+    receiver_address: string;
+    balance: number;
+    resource?: Resource;
+}
+
+export interface WithdrawExpireUnfreezeContract {
+    owner_address: string;
+}
+
+export interface CreateSmartContract {
+    owner_address: string;
+    call_token_value: number;
+    token_id: string;
+    new_contract: {
+        name: string;
+        origin_address: string;
+        contract_address: string;
+        abi: { entrys?: ContractAbiInterface };
+        bytecode: string;
+        call_value: number;
+        consume_user_resource_percent: number;
+        origin_energy_limit: number;
+    };
+}
+
+export interface DeployConstantContract {
+    data: string;
+    owner_address: string;
+    call_value?: number;
+    token_id?: number | string;
+    call_token_value?: number | string;
+}
+
+export interface ClearABIContract {
+    contract_address: string;
+    owner_address: string;
+}
+
+export interface UpdateBrokerageContract {
+    brokerage: number;
+    owner_address: string;
+}
+
+interface FrozenSupply {
+    frozen_amount: number;
+    frozen_days: number;
+}
+export interface AssetIssueContract {
+    owner_address: string;
+    name: string;
+    abbr: string;
+    description: string;
+    url: string;
+    total_supply: number;
+    trx_num: number;
+    num: number;
+    start_time: number;
+    end_time: number;
+    precision: number;
+    free_asset_net_limit: number;
+    public_free_asset_net_limit: number;
+    public_free_asset_net_usage: number;
+    public_latest_free_net_time: number;
+    vote_score: number;
+    frozen_supply: FrozenSupply[];
+}
+
+export interface AccountCreateContract {
+    account_address: string;
+    owner_address: string;
+}
+
+export interface AccountUpdateContract {
+    account_name: string;
+    owner_address: string;
+}
+
+export interface SetAccountIdContract {
+    account_id: string;
+    owner_address: string;
+}
+
+export interface ProposalCreateContract {
+    owner_address: string;
+    parameters: Record<string, string | number>[];
+}
+
+export interface ProposalDeleteContract {
+    owner_address: string;
+    proposal_id: number;
+}
+
+export interface VoteProposalContract {
+    owner_address: string;
+    proposal_id: number;
+    is_add_approval: boolean;
+}
+
+export interface ExchangeCreateContract {
+    owner_address: string;
+    first_token_id: string;
+    first_token_balance: number;
+    second_token_id: string;
+    second_token_balance: number;
+}
+
+export interface ExchangeInjectContract {
+    owner_address: string;
+    exchange_id: number;
+    token_id: string;
+    quant: number;
+}
+
+export interface ExchangeWithdrawContract {
+    owner_address: string;
+    exchange_id: number;
+    token_id: string;
+    quant: number;
+}
+
+export interface ExchangeTransactionContract {
+    owner_address: string;
+    exchange_id: number;
+    token_id: string;
+    quant: number;
+    expected: number;
+}
+
+export interface UpdateSettingContract {
+    owner_address: string;
+    contract_address: string;
+    consume_user_resource_percent: number;
+}
+
+export interface UpdateEnergyLimitContract {
+    owner_address: string;
+    contract_address: string;
+    origin_energy_limit: number;
+}
+
+export interface AccountPermissionUpdateContract {
+    owner_address: string;
+    owner?: Permission;
+    witness?: Permission;
+    actives?: Permission[];
+}
+
+export interface UpdateAssetContract {
+    owner_address: string;
+    description: string;
+    url: string;
+    new_limit?: number;
+    new_public_limit?: number;
+}
+
+export interface WitnessCreateContract {
+    owner_address: string;
+    url: string;
+}
+
+export interface VoteWitnessContract {
+    owner_address: string;
+    votes: { vote_address: string; vote_count: number }[];
+}
+
+export type ContractParamter =
+    | TransferContract
+    | TransferAssetContract
+    | ParticipateAssetIssueContract
+    | TriggerSmartContract
+    | FreezeBalanceContract
+    | UnfreezeBalanceContract
+    | WithdrawBalanceContract
+    | FreezeBalanceV2Contract
+    | CancelFreezeBalanceV2Contract
+    | UnfreezeBalanceV2Contract
+    | DelegateResourceContract
+    | UnDelegateResourceContract
+    | WithdrawExpireUnfreezeContract
+    | CreateSmartContract
+    | ClearABIContract
+    | UpdateBrokerageContract
+    | AssetIssueContract
+    | AccountCreateContract
+    | AccountUpdateContract
+    | SetAccountIdContract
+    | ProposalCreateContract
+    | ProposalDeleteContract
+    | VoteProposalContract
+    | ExchangeCreateContract
+    | ExchangeInjectContract
+    | ExchangeWithdrawContract
+    | ExchangeTransactionContract
+    | UpdateSettingContract
+    | UpdateEnergyLimitContract
+    | AccountPermissionUpdateContract
+    | UpdateAssetContract
+    | WitnessCreateContract
+    | VoteWitnessContract;

package/src/types/Providers.ts

@@ -0,0 +1,7 @@
+import { RawAxiosRequestHeaders, AxiosHeaders, HeadersDefaults } from 'axios';
+export type HeadersType = RawAxiosRequestHeaders | InstanceType<typeof AxiosHeaders> | Partial<HeadersDefaults>;
+export type RequestHeaders = RawAxiosRequestHeaders;
+
+export interface HttpProviderInstance {
+    request<R = unknown>(config: any): Promise<{ data: R }>;
+}

package/src/types/Transaction.ts

@@ -0,0 +1,70 @@
+import { ContractParamter, ContractType, CreateSmartContract, TriggerSmartContract } from './Contract.js';
+
+export interface ContractParamterWrapper<T = ContractParamter> {
+    value: T;
+    type_url: string;
+}
+export interface TransactionContract<T = ContractParamter> {
+    type: ContractType;
+    parameter: ContractParamterWrapper<T>;
+    Permission_id?: number;
+}
+
+export interface Transaction<T = ContractParamter> {
+    visible: boolean;
+    txID: string;
+    raw_data: {
+        contract: TransactionContract<T>[];
+        ref_block_bytes: string;
+        ref_block_hash: string;
+        expiration: number;
+        timestamp: number;
+        data?: unknown;
+        fee_limit?: unknown;
+    };
+    raw_data_hex: string;
+}
+
+export interface CreateSmartContractTransaction extends Transaction<CreateSmartContract> {
+    /**
+     * Address of smart contract.
+     */
+    contract_address: string;
+}
+
+/**
+ * `TransactionWrapper` interface is returned when user trigger a smart contract.
+ */
+export interface TransactionWrapper {
+    Error?: string;
+    result: {
+        result: boolean;
+        message?: string;
+    };
+    /**
+     * The transaction object created by calling contract function.
+     */
+    transaction: Transaction<TriggerSmartContract>;
+    /**
+     * Energy required for successfully deploying new contract or trigger contract.
+     * This is returned in `transactionBuilder.estimateEnergy()` and `transactionBuilder.deployConstantContract()`
+     */
+    energy_required?: number;
+    /**
+     * The penalty energy consumption.
+     */
+    energy_penalty?: number;
+    /**
+     * Energy used by triggering contract.
+     */
+    energy_used?: number;
+    /**
+     * Result of calling contract function which is decorated by `view` or `pure`.
+     */
+    constant_result?: any;
+}
+
+export interface SignedTransaction<T extends ContractParamter = ContractParamter> extends Transaction<T> {
+    signature: string[];
+    contract_address?: string;
+}

package/src/types/TransactionBuilder.ts

@@ -0,0 +1,281 @@
+import { AbiFragment, ContractAbiInterface } from './ABI.js';
+import { Transaction } from './Transaction.js';
+
+export interface TransactionCommonOptions {
+    /**
+     * Permission id for multi-sign.
+     */
+    permissionId?: number;
+    blockHeader?: Partial<Transaction['raw_data']>;
+}
+
+
+export type NumberLike = string | number;
+
+export type Resource = 'BANDWIDTH' | 'ENERGY';
+
+export interface VoteInfo {
+    [srAddress: string]: number;
+}
+
+export interface CreateSmartContractOptions extends TransactionCommonOptions {
+    /**
+     * The maximum TRX burns for resource consumption（1TRX = 1,000,000SUN）.
+     */
+    feeLimit?: number;
+    /**
+     * The TRX transfer to the contract for each call（1TRX = 1,000,000SUN）
+     */
+    callValue?: number;
+    /**
+     * The id of trc10 token transfer to the contract (Optional)
+     */
+    tokenId?: string;
+    /**
+     * The amount of trc10 token transfer to the contract for each call (Optional)
+     */
+    tokenValue?: number;
+    /**
+     * Consume user's resource percentage. It should be an integer between [0, 100].
+     * if 0, means it does not consume user's resource until the developer's resource has been used up.
+     */
+    userFeePercentage?: number;
+    /**
+     * The maximum resource consumption of the creator in one execution or creation.
+     */
+    originEnergyLimit?: number;
+    /**
+     * Abi string
+     */
+    abi: string | { entrys: ContractAbiInterface } | ContractAbiInterface;
+    /**
+     * Bytecode, default hexString.
+     */
+    bytecode: string;
+    /**
+     * The list of the parameters of the constructor.
+     * It should be converted hexString after encoded according to ABI encoder.
+     * If constructor has no parameter, this can be optional
+     */
+    parameters?: unknown[];
+    /**
+     * Contract name string.
+     */
+    name?: string;
+    /**
+     * Optional. raw parameters encoded according to [ABI Specification](https://docs.soliditylang.org/en/latest/abi-spec.html)
+     * For example: 0x0000000000000000000000000000000000000000000000000000000000000001.
+     */
+    rawParameter?: string;
+    /**
+     * Optional. JSON format for contract function.
+     * For example: { "type":"function", "inputs": [{"name":"a","type":"uint256"}], "name":"foo", "outputs": [] }
+     */
+    funcABIV2?: AbiFragment;
+    /**
+     * The parameters of the function specified by `funcABIV2`.
+     * Required if `funcABIV2` exists.
+     */
+    parametersV2?: unknown[];
+}
+
+export interface TriggerSmartContractOptions extends TransactionCommonOptions {
+    /**
+     * The maximum TRX burns for resource consumption in SUN（1TRX = 1,000,000SUN）.
+     */
+    feeLimit?: number;
+    /**
+     * The TRX transfer to the contract for each call in SUN（1TRX = 1,000,000SUN）
+     */
+    callValue?: number;
+    /**
+     * The id of trc10 token transfer to the contract (Optional)
+     */
+    tokenId?: string;
+    /**
+     * The amount of trc10 token transfer to the contract for each call (Optional)
+     */
+    tokenValue?: number;
+    /**
+     * JSON format for contract function.
+     * For example: `{ "type":"function", "inputs": [{"name":"a","type":"uint256"}], "name":"foo", "outputs": [] }`.
+     * If exists, the `parameters` will be ignored.
+     * Optional.
+     */
+    funcABIV2?: AbiFragment;
+    /**
+     * The parameters of the function specified by `funcABIV2`.
+     * Required if `funcABIV2` exists.
+     */
+    parametersV2?: unknown[];
+    /**
+     * Raw parameters encoded according to [ABI Specification](https://docs.soliditylang.org/en/latest/abi-spec.html).
+     * If exists, the `parametersV2` and `parameters` will be ignored.
+     * For example: 0x0000000000000000000000000000000000000000000000000000000000000001.
+     * Optional.
+     */
+    shieldedParameter?: string;
+    /**
+     * Alias of `shieldedParameter`. If exists, the `shieldedParameter`, `parametersV2` and `parameters` will be ignored.
+     */
+    rawParameter?: string;
+    /**
+     * If functionSelector is not specified, this parameter will be used as data.
+     */
+    input?: string;
+    /**
+     * Create transaction locally.
+     */
+    txLocal?: boolean;
+    _isConstant?: boolean;
+    /**
+     * If use solidity node to trigger smart contract.
+     */
+    confirmed?: boolean;
+}
+export interface TriggerConstantContractOptions extends TriggerSmartContractOptions {
+    _isConstant?: boolean;
+    /**
+     * Whether the request only aims to estimating energy not trigger contract actually.
+     */
+    estimateEnergy?: boolean;
+    /**
+     * If use solidity node to trigger smart contract.
+     */
+    confirmed?: boolean;
+}
+// @todo: more detailed type
+export interface ContractFunctionParameter {
+    type: string;
+    value: unknown;
+}
+
+export interface CreateTokenOptions extends TransactionCommonOptions {
+    /**
+     * Token name, default string.
+     */
+    name: string;
+    /**
+     * Token name abbreviation, default string.
+     */
+    abbreviation: string;
+    /**
+     * Token description, default string.
+     */
+    description?: string;
+    /**
+     * Token official website url, default string.
+     */
+    url: string;
+    /**
+     * Token total supply.
+     */
+    totalSupply: number;
+    /**
+     * Define the price by the ratio of trx_num/num.
+     * Default is 1.
+     */
+    trxRatio: number;
+    /**
+     * Define the price by the ratio of trx_num/num.
+     * Default is 1.
+     */
+    tokenRatio: number;
+    /**
+     * ICO start time.
+     */
+    saleStart: number;
+    /**
+     * ICO end time.
+     */
+    saleEnd: number;
+    /**
+     * The creator's "donated" bandwidth for use by token holders.
+     * Default is 0.
+     */
+    freeBandwidth?: number;
+    /**
+     * Out of `totalFreeBandwidth`, the amount each token holder get.
+     * Default is 0.
+     */
+    freeBandwidthLimit?: number;
+    /**
+     * Token staked supply.
+     * Default is 0.
+     */
+    frozenAmount?: number;
+    /**
+     * Token staked duration.
+     * Default is 0.
+     */
+    frozenDuration?: number;
+    /**
+     * @todo: desc
+     */
+    voteScore?: number;
+    /**
+     * Precision of issued tokens.
+     */
+    precision?: number;
+}
+
+export interface UpdateTokenOptions extends TransactionCommonOptions {
+    /**
+     * The description of token.
+     * Optional.
+     */
+    description?: string;
+    /**
+     * The token's website url.
+     */
+    url: string;
+    /**
+     * Each token holder's free bandwidth.
+     * Optional.
+     */
+    freeBandwidth?: number;
+    /**
+     * The total free bandwidth of the token.
+     * Optional. Default is 0.
+     */
+    freeBandwidthLimit?: number;
+}
+
+export interface DeployConstantContractOptions {
+    /**
+     * The bytecode of contract to be deployed.
+     */
+    input: string;
+    /**
+     * Owner address of the new contract.
+     */
+    ownerAddress: string;
+    /**
+     * The id of token to be transfered to the new contract.
+     * Optional.
+     */
+    tokenId?: string | number;
+    /**
+     * The amount of token to be transfered to the new contract.
+     */
+    tokenValue?: string | number;
+    /**
+     * Amount of TRX transferred with this transaction, measured in SUN (1TRX = 1,000,000 SUN).
+     */
+    callValue?: number;
+    /**
+     * Whether send request to solidity node.
+     */
+    confirmed?: boolean;
+}
+
+export interface AlterTransactionOptions {
+    data?: string;
+    dataFormat?: string;
+    extension?: number;
+    txLocal?: boolean;
+}
+
+export interface TxLocal {
+    txLocal?: boolean;
+}