Home

Types

• Wallet: Represents an Aptos wallet.
• Serializer: A BCS (Binary Canonical Serialization) Serializer meant for serializing data
• Mnemonic: Used for deriving BIP39 Phrases
• HTTPMethod: Uses URLRequest to set up a HTTPMethod, and implement default values for the method cases.
• AptosError
• SeedMode
• Mnemonic.Error
• Wordlists
• UInt128Errors: An ErrorType for UInt128 data types. It includes cases for errors that can occur during string conversion.
• Account: Aptos Blockchain Account
• Ed25519BIP32: Used for deriving Seed Phrases for the HDWallet
• RotatingProofChallenge: Used for the rotating proof challenge for the Aptos Blockchain
• AccountAddress: The Aptos Blockchain Account Address
• Ed25519Authenticator
• MultiAgentAuthenticator
• MultiEd25519Authenticator
• ClientConfig: Client Configuration for the REST client
• AccountResponse: Response to the Get Account REST endpoint
• AptosRestClientError: An error associated with the Aptos REST Client
• InfoResponse: The API response to Get Info REST endpoint
• Collection
• InvalidPropertyType
• Object
• Property
• PropertyMap
• Royalty
• Token
• AnyTransactionArgument: Used for wrapping transaction arguments for supporting both singular and array objects
• EntryFunction: Aptos Blockchain Entry Function
• ModuleBundle: Aptos Blockchain Module Bundle
• ModuleId: Aptos Blockchain Module ID
• MultiAgentRawTransaction: Aptos Blockchain Multi-Agent Raw Transaction
• RawTransaction
• Script
• ScriptArgument: Aptos Blockchain Script Argument
• SignedTransaction: Aptos Blockchain Signed Transaction
• TransactionArgument: Aptos Blockchain Transaction Argument
• AccountAddressTag: AccountAddress Type Tag
• BoolTag: Bool Type Tag
• StructTag: Struct Type Tag
• StructTagValue: The value contents of a Struct Tag
• U128Tag: UInt128 Type Tag
• U16Tag: UInt16 Type Tag
• U256Tag: UInt256 Type Tag
• U32Tag: UInt32 Type Tag
• U64Tag: UInt64 Type Tag
• U8Tag: UInt8 Type Tag
• UInt128: A 128-bit unsigned integer value type. Storage is based upon a tuple of 2, 64-bit, unsigned integers.
• MultiPublicKey: The ED25519 Multi-Public Key
• MultiSignature: The ED25519 Multi-Signature
• PrivateKey: The ED25519 Private Key
• PublicKey: The ED25519 Public Key
• Signature: The ED25519 Signature

Protocols

• AuthenticatorProtocol
• EncodingContainer
• EncodingProtocol
• KeyProtocol
• ReadObjectProtocol
• TransactionProtocol
• TypeProtcol

Global Functions

• decodeData(_:​with:​keyDecodingStrategy:​dataDecodingStrategy:​dateDecodingStrategy:​): Decode a data object using JSONDecoder.decode().
• asyncData(with:​method:​headers:​body:​): Takes a URL input, along with header information, and converts it into a URLRequest; and fetches the data using an Async Await wrapper for the older dataTask handler.
• decodeUrl(_:​with:​): Decode a URL to the type T using either asyncData() for the Production Server; or using decode() for the Mock Server.
• decodeUrl(with:​_:​): Decodes the contents of the specified URL into a JSON object using the specified HTTP method.
• decodeUrl(with:​_:​): Decodes the contents of the specified URL into a JSON object using the specified HTTP method and request body.
• decodeUrl(with:​_:​_:​): Decodes the contents of the specified URL into a JSON object using the specified HTTP headers and request body.
• verify(_:​): Verifies the authenticity of a given data.
• deserialize(from:​)
• serialize(_:​)
• readObject(address:​): Fetches and returns a ReadObject from the given account address.
• createCollectionPayload(:​:​_:​_:​_:​_:​_:​_:​_:​_:​_:​_:​_:​_:​_:​): Constructs a TransactionPayload for creating a new token collection.
• createCollection(:​:​_:​_:​_:​_:​_:​_:​_:​_:​_:​_:​_:​_:​_:​_:​): Creates a new token collection using the given parameters.
• mintTokenPayload(:​:​_:​_:​_:​): Constructs a TransactionPayload for minting a new token within a specified collection.
• mintToken(:​:​_:​_:​_:​_:​): Mints a new token within a specified collection using the given parameters.
• mintSoulBoundToken(:​:​_:​_:​_:​_:​_:​): Mints a new soul-bound token within a specified collection using the given parameters.
• burnToken(:​:​): Burns a token from the given creator's account.
• freezeToken(:​:​): Freezes the transfer of a token from the given creator's account.
• unfreezeToken(:​:​): Unfreezes the transfer of a token from the given creator's account.
• addTokenProperty(:​:​_:​): Adds a property to a token from the given creator's account.
• removeTokenProperty(:​:​_:​): Removes a property from a token from the given creator's account.
• updateTokenProperty(:​:​_:​): Updates a property of a token from the given creator's account.
• fundAccount(:​:​): Fund an account on the blockchain with a specified amount of currency.
• account(_:​ledgerVersion:​)
• accountBalance(_:​_:​)
• accountSequenceNumber(_:​_:​)
• accountResource(_:​_:​_:​)
• accountResources(_:​_:​)
• getTableItem(_:​_:​_:​_:​_:​_:​)
• aggregatorValue(_:​_:​_:​)
• info()
• simulateTransaction(_:​_:​)
• submitBcsTransaction(_:​)
• submitTransaction(_:​_:​)
• transactionPending(_:​)
• waitForTransaction(_:​)
• createMultiAgentBcsTransaction(_:​_:​_:​)
• createBcsTransaction(_:​_:​)
• createBcsTransaction(_:​_:​_:​)
• createBcsSignedTransaction(_:​_:​)
• createBcsSignedTransaction(_:​_:​_:​)
• transfer(_:​_:​_:​)
• bcsTransfer(_:​_:​_:​)
• createCollection(_:​_:​_:​_:​)
• createToken(_:​_:​_:​_:​_:​_:​_:​)
• offerToken(_:​_:​_:​_:​_:​_:​_:​)
• claimToken(_:​_:​_:​_:​_:​_:​)
• directTransferToken(_:​_:​_:​_:​_:​_:​_:​)
• getToken(_:​_:​_:​_:​_:​)
• getTokenBalance(_:​_:​_:​_:​_:​)
• getTokenData(_:​_:​_:​_:​)
• getCollection(_:​_:​)
• publishPackage(_:​_:​_:​)
• deserialize(from:​)
• serialize(_:​)
• deserialize(from:​)
• serialize(_:​)
• remaining(): Calculate the remaining number of bytes in the input data buffer.
• bool(): Deserialize a boolean value from the Serializer's input data buffer.
• toBytes(_:​): Deserialize a Data object from the Deserializer's input data buffer.
• fixedBytes(length:​): Deserialize a fixed-length Data object from the Deserializer's input data buffer.
• map(keyDecoder:​valueDecoder:​): Deserialize a dictionary of key-value pairs from the Deserializer's input data buffer.
• sequence(valueDecoder:​): Deserialize a sequence of values from the Deserializer's input data buffer.
• string(_:​): Deserialize a string from the Deserializer's input data buffer.
• struct(:​): Deserialize a structure that conforms to the KeyProtocol from the Deserializer's input data buffer.
• u8(_:​): Deserialize a UInt8 value from the Deserializer's input data buffer.
• u16(_:​): Deserialize a UInt16 value from the Deserializer's input data buffer.
• u32(_:​): Deserialize a UInt32 value from the Deserializer's input data buffer.
• u64(_:​): Deserialize a UInt64 value from the Deserializer's input data buffer.
• u128(_:​): Deserialize a UInt128 value from the Deserializer's input data buffer.
• u256(_:​): Deserialize a UInt256 value from the Deserializer's input data buffer.
• uleb128(): Deserialize an unsigned LEB128-encoded integer from the Deserializer's input data buffer.

Global Variables

• ed25519
• multiEd25519
• multiAgent
• client: REST Client used for communicating with the Aptos Blockchain
• baseUrl
• restClient
• chainId
• client
• clientConfig
• baseUrl
• script: Script Payload
• moduleBundle: Module Bundle Payload
• scriptFunction: Script Function Payload
• bool: Boolean Type Tag
• u8: UInt8 Type Tag
• u64: UInt64 Type Tag
• u128: UInt128 Type Tag
• accountAddress: AccountAddress Type Tag
• signer: Signer Type Tag
• vector: Vector Type Tag
• _struct: Struct Type Tag
• u16: UInt16 Type Tag
• u32: UInt32 Type Tag
• u256: UInt256 Type Tag

Extensions

• Array
• BinaryFloatingPoint
• Data
• String