/** * The IDL of the module. * * @module */ /** The IDL of the module. */ export declare const idl: { readonly module_id: "0x1::coin"; readonly doc: "This module provides the foundation for typesafe Coins."; readonly functions: readonly [{ readonly name: "transfer"; readonly doc: "Transfers `amount` of coins `CoinType` from `from` to `to`."; readonly ty_args: readonly ["CoinType"]; readonly args: readonly [{ readonly name: "to"; readonly ty: "address"; }, { readonly name: "amount"; readonly ty: "u64"; }]; }]; readonly structs: readonly [{ readonly name: "0x1::coin::BurnCapability"; readonly doc: "Capability required to burn coins."; readonly fields: readonly [{ readonly name: "dummy_field"; readonly ty: "bool"; }]; readonly type_params: readonly [{ readonly name: "CoinType"; readonly is_phantom: true; }]; readonly abilities: readonly ["copy", "store"]; }, { readonly name: "0x1::coin::Coin"; readonly doc: "Core data structures\nMain structure representing a coin/token in an account's custody."; readonly fields: readonly [{ readonly name: "value"; readonly doc: "Amount of coin this address has."; readonly ty: "u64"; }]; readonly type_params: readonly [{ readonly name: "CoinType"; readonly is_phantom: true; }]; readonly abilities: readonly ["store"]; }, { readonly name: "0x1::coin::CoinInfo"; readonly doc: "Information about a specific coin type. Stored on the creator of the coin's account."; readonly fields: readonly [{ readonly name: "name"; readonly ty: { readonly struct: { readonly name: "0x1::string::String"; }; }; }, { readonly name: "symbol"; readonly doc: "Symbol of the coin, usually a shorter version of the name.\nFor example, Singapore Dollar is SGD."; readonly ty: { readonly struct: { readonly name: "0x1::string::String"; }; }; }, { readonly name: "decimals"; readonly doc: "Number of decimals used to get its user representation.\nFor example, if `decimals` equals `2`, a balance of `505` coins should\nbe displayed to a user as `5.05` (`505 / 10 ** 2`)."; readonly ty: "u8"; }, { readonly name: "supply"; readonly doc: "Amount of this coin type in existence."; readonly ty: { readonly struct: { readonly name: "0x1::option::Option"; readonly ty_args: readonly ["u128"]; }; }; }]; readonly type_params: readonly [{ readonly name: "CoinType"; readonly is_phantom: true; }]; readonly abilities: readonly ["key"]; }, { readonly name: "0x1::coin::CoinStore"; readonly doc: "A holder of a specific coin types and associated event handles.\nThese are kept in a single resource to ensure locality of data."; readonly fields: readonly [{ readonly name: "coin"; readonly ty: { readonly struct: { readonly name: "0x1::coin::Coin"; readonly ty_args: readonly [{ readonly type_param: 0; }]; }; }; }, { readonly name: "frozen"; readonly ty: "bool"; }, { readonly name: "deposit_events"; readonly ty: { readonly struct: { readonly name: "0x1::event::EventHandle"; readonly ty_args: readonly [{ readonly struct: { readonly name: "0x1::coin::DepositEvent"; }; }]; }; }; }, { readonly name: "withdraw_events"; readonly ty: { readonly struct: { readonly name: "0x1::event::EventHandle"; readonly ty_args: readonly [{ readonly struct: { readonly name: "0x1::coin::WithdrawEvent"; }; }]; }; }; }]; readonly type_params: readonly [{ readonly name: "CoinType"; readonly is_phantom: true; }]; readonly abilities: readonly ["key"]; }, { readonly name: "0x1::coin::DepositEvent"; readonly doc: "Event emitted when some amount of a coin is deposited into an account."; readonly fields: readonly [{ readonly name: "amount"; readonly ty: "u64"; }]; readonly abilities: readonly ["drop", "store"]; }, { readonly name: "0x1::coin::FreezeCapability"; readonly doc: "Capability required to freeze a coin store."; readonly fields: readonly [{ readonly name: "dummy_field"; readonly ty: "bool"; }]; readonly type_params: readonly [{ readonly name: "CoinType"; readonly is_phantom: true; }]; readonly abilities: readonly ["copy", "store"]; }, { readonly name: "0x1::coin::MintCapability"; readonly doc: "Capability required to mint coins."; readonly fields: readonly [{ readonly name: "dummy_field"; readonly ty: "bool"; }]; readonly type_params: readonly [{ readonly name: "CoinType"; readonly is_phantom: true; }]; readonly abilities: readonly ["copy", "store"]; }, { readonly name: "0x1::coin::WithdrawEvent"; readonly doc: "Event emitted when some amount of a coin is withdrawn from an account."; readonly fields: readonly [{ readonly name: "amount"; readonly ty: "u64"; }]; readonly abilities: readonly ["drop", "store"]; }]; readonly errors: { readonly "1": { readonly name: "ECOIN_INFO_ADDRESS_MISMATCH"; readonly doc: "Address of account which is used to initialize a coin `CoinType` doesn't match the deployer of module"; }; readonly "2": { readonly name: "ECOIN_INFO_ALREADY_PUBLISHED"; readonly doc: "`CoinType` is already initialized as a coin"; }; readonly "3": { readonly name: "ECOIN_INFO_NOT_PUBLISHED"; readonly doc: "`CoinType` hasn't been initialized as a coin"; }; readonly "4": { readonly name: "ECOIN_STORE_ALREADY_PUBLISHED"; readonly doc: "Account already has `CoinStore` registered for `CoinType`"; }; readonly "5": { readonly name: "ECOIN_STORE_NOT_PUBLISHED"; readonly doc: "Account hasn't registered `CoinStore` for `CoinType`"; }; readonly "6": { readonly name: "EINSUFFICIENT_BALANCE"; readonly doc: "Not enough coins to complete transaction"; }; readonly "7": { readonly name: "EDESTRUCTION_OF_NONZERO_TOKEN"; readonly doc: "Cannot destroy non-zero coins"; }; readonly "8": { readonly name: "ETOTAL_SUPPLY_OVERFLOW"; readonly doc: "Total supply of the coin has overflown. No additional coins can be minted"; }; readonly "9": { readonly name: "EZERO_COIN_AMOUNT"; readonly doc: "Coin amount cannot be zero"; }; readonly "10": { readonly name: "EFROZEN"; readonly doc: "CoinStore is frozen. Coins cannot be deposited or withdrawn"; }; }; }; //# sourceMappingURL=idl.d.ts.map