diff --git a/Account/index.html b/Account/index.html deleted file mode 100644 index 7fe9de0f..00000000 --- a/Account/index.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - KukaiCoreSwift - Account - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Account -

- -
-
public struct Account: Codable, Hashable  
-
-
-

Fetching all the account balances is a lengthy task, involving many requests and parsing different structures. -This struct abstract the developer away from knowing all these details, and instead allows developers to access wallets balances in a more normal approach

- -
-
- -
- - - - - - -%173 - - - -Account - - -Account - - - - - -Codable - -Codable - - - -Account->Codable - - - - - -Hashable - -Hashable - - - -Account->Hashable - - - - - -Identifiable - -Identifiable - - - -Account->Identifiable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Hashable
-
Identifiable
-
-
-
-

Initializers

- -
-

- init(wallet​Address:​) -

-
-
public init(walletAddress: String)  
-
-
-

Basic init to default properties to zero / empty, so that optionals can be avoided on a key model throughout an app

- -
-
-
-

- init(wallet​Address:​xtz​Balance:​tokens:​nfts:​recent​NFTs:​liquidity​Tokens:​delegate:​delegation​Level:​) -

-
-
public init(walletAddress: String, xtzBalance: XTZAmount, tokens: [Token], nfts: [Token], recentNFTs: [NFT], liquidityTokens: [DipDupPositionData], delegate: TzKTAccountDelegate?, delegationLevel: Decimal?)  
-
-
-

Full init

- -
-
-
-
-

Properties

- -
-

- wallet​Address -

-
-
public let walletAddress: String
-
-
-

The wallet address

- -
-
-
-

- xtz​Balance -

-
-
public let xtzBalance: XTZAmount
-
-
-

The XTZ balance of the wallet

- -
-
-
-

- tokens -

-
-
public let tokens: [Token] 
-
-
-

All the wallets FA1.2, FA2 funginble tokens

- -
-
-
-

- nfts -

-
-
public let nfts: [Token] 
-
-
-

All the wallets NFT's, grouped into parent FA2 objects so they can be displayed in groups or individaully

- -
-
-
-

- recent​NFTs -

-
-
public var recentNFTs: [NFT] 
-
-
-

10 most recent NFTs to hit the wallet

- -
-
-
-

- liquidity​Tokens -

-
-
public let liquidityTokens: [DipDupPositionData] 
-
-
-

All the wallets Defi, Liquidity Tokens

- -
-
-
-

- delegate -

-
-
public let delegate: TzKTAccountDelegate? 
-
-
-

TzKT object containing baker details + status

- -
-
-
-

- delegation​Level -

-
-
public let delegationLevel: Decimal? 
-
-
-

The block level that the delegate was set

- -
-
-
-

- id -

-
-
public var id: String  
-
-
-
-
-

Methods

- -
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-

Conforming to Hashable to enable working with UITableViewDiffableDataSource

- -
-
-
- - - -
-
- - - - diff --git a/AggregateRewardInformation/index.html b/AggregateRewardInformation/index.html deleted file mode 100644 index 8ca47d2b..00000000 --- a/AggregateRewardInformation/index.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - KukaiCoreSwift - AggregateRewardInformation - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Aggregate​Reward​Information -

- -
-
public struct AggregateRewardInformation: Codable, Hashable, Equatable  
-
-
-

Object ot abstract away a significatn amount of logic involved in computing estimated reward payments from a baker

- -
-
- -
- - - - - - -%667 - - - -AggregateRewardInformation - - -AggregateRewardInformation - - - - - -Equatable - -Equatable - - - -AggregateRewardInformation->Equatable - - - - - -Hashable - -Hashable - - - -AggregateRewardInformation->Hashable - - - - - -Codable - -Codable - - - -AggregateRewardInformation->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Equatable
-
Hashable
-
-
-
-

Initializers

- -
-

- init(previous​Reward:​estimated​Previous​Reward:​estimated​Next​Reward:​) -

-
-
public init(previousReward: RewardDetails?, estimatedPreviousReward: RewardDetails?, estimatedNextReward: RewardDetails?)  
-
-
-
-
-

Properties

- -
-

- previous​Reward -

-
-
public let previousReward: RewardDetails? 
-
-
-
-

- estimated​Previous​Reward -

-
-
public let estimatedPreviousReward: RewardDetails? 
-
-
-
-

- estimated​Next​Reward -

-
-
public let estimatedNextReward: RewardDetails? 
-
-
-
-
-

Methods

- -
-

- is​Out​OfDate() -

-
-
public func isOutOfDate() -> Bool  
-
-
-

Creating this object involves many expensive requests, but produces a result that is valid for up to ~3 days. -This function can be used to determine if its ok to read a previous object from a cache, or if it needs to be refreshed

- -
-
-
-

- more​Than1Cycle​Between​Preious​And​Next() -

-
-
public func moreThan1CycleBetweenPreiousAndNext() -> Bool  
-
-
-

When previousReward is present, it is possible that due to a delay in payment being received, that we may cache an object before the last payment was received -In this case, if we only relied on isOutOfDate() we would not update again for ~3 days. Both checks will be needed

- -
-
-
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: AggregateRewardInformation, rhs: AggregateRewardInformation) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/AnyPublisher/index.html b/AnyPublisher/index.html deleted file mode 100644 index 7c3e4382..00000000 --- a/AnyPublisher/index.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - KukaiCoreSwift - AnyPublisher - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - AnyPublisher -

-
-

Methods

- -
-

- just(_:​) -

-
-
static func just(_ output: Output) -> Self  
-
-
-

Helper for returning a Just publisher, with the appropriate Failure type and erased to AnyPublisher

- -
-
-
-

- fail(with:​) -

-
-
static func fail(with error: Failure) -> Self  
-
-
-

Helper for returning a Fail publisher, erased to AnyPublisher

- -
-
-
-

- on​Receive​Output(_:​) -

-
-
func onReceiveOutput(_ callback: @escaping ((Self.Output) -> Void)) -> Publishers.HandleEvents<Self>  
-
-
-

Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

- -
-
-
-

- sink(on​Error:​on​Success:​on​Complete:​) -

-
-
func sink(onError: @escaping ((Failure) -> Void), onSuccess: @escaping ((Output) -> Void), onComplete: (() -> Void)? = nil) -> AnyCancellable  
-
-
-

Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

- -
-
-
-
-
- - - - diff --git a/Array/index.html b/Array/index.html deleted file mode 100644 index 49bcc5e2..00000000 --- a/Array/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - KukaiCoreSwift - Array - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - Array -

-
-

Methods

- -
-

- copy​Operations() -

-
-
public func copyOperations() -> [Operation]  
-
-
-

Operation's are classes, passed by reference, but often require making copies so that you can manipulate them before sending to be estimated. -Function make it easy by converting the array to JSON and recreating, avoiding issues where construnctors manipulate inputs before storing

- -
-
-
-

- michelson​Int(at​Index:​) -

-
-
func michelsonInt(atIndex index: Int) -> String?  
-
-
-
-

- michelson​String(at​Index:​) -

-
-
func michelsonString(atIndex index: Int) -> String?  
-
-
-
-

- michelson​Pair(at​Index:​) -

-
-
func michelsonPair(atIndex index: Int) -> [String: Any]?  
-
-
-
-

- michelson​Int(at​Index:​) -

-
-
func michelsonInt(atIndex index: Int) -> String?  
-
-
-
-

- michelson​String(at​Index:​) -

-
-
func michelsonString(atIndex index: Int) -> String?  
-
-
-
-

- michelson​Pair(at​Index:​) -

-
-
func michelsonPair(atIndex index: Int) -> [String: Any]?  
-
-
-
-

- michelson​Array(at​Index:​) -

-
-
func michelsonArray(atIndex index: Int) -> [Any]?  
-
-
-
-
-
- - - - diff --git a/BalanceUpdate/index.html b/BalanceUpdate/index.html deleted file mode 100644 index 564415aa..00000000 --- a/BalanceUpdate/index.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - KukaiCoreSwift - BalanceUpdate - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Balance​Update -

- -
-
public struct BalanceUpdate: Codable  
-
-
-

Struct representing a change to the balance of the sender, destination or intermediary contract

- -
-
- -
- - - - - - -%307 - - - -BalanceUpdate - - -BalanceUpdate - - - - - -Codable - -Codable - - - -BalanceUpdate->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
- - - - -
-
- - - - diff --git a/BetterCallDevClient/index.html b/BetterCallDevClient/index.html deleted file mode 100644 index e3be8d06..00000000 --- a/BetterCallDevClient/index.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - KukaiCoreSwift - BetterCallDevClient - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Better​Call​Dev​Client -

- -
-
public class BetterCallDevClient  
-
-
-

BetterCallDev (BCD) is an indexer/smart contract debugging tool, used for the Tezos blockchain. -This class allows developers to interact with their API, to fetch data that would otherwise be impossible for a mobile app to fetch from the Tezos RPC

- -
-
- - -

Nested Types

-
-
BetterCallDevClient.BetterCallDevClientError
-

Dedicated BCD errors

-
-
-
-
-

Initializers

- -
-

- init(network​Service:​config:​) -

-
-
public init(networkService: NetworkService, config: TezosNodeClientConfig)  
-
-
-

Init a BetterCallDevClient with a NetworkService and a TezosNodeClientConfig.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
network​ServiceNetwork​Service

NetworkService used to manage network communication.

-
configTezos​Node​Client​Config

TezosNodeClientConfig used to apss in settings.

-
-
-
-
-

Methods

- -
-

- get​More​Detailed​Error(by​Hash:​completion:​) -

-
-
public func getMoreDetailedError(byHash hash: String, completion: @escaping ((BetterCallDevOperationError?, KukaiError?) -> Void))  
-
-
-

Primarily the TzKTClient is used to fetch details on operations. However for more complex calls involving smart contracts, TzKT will only return limited error message info. -BetterCallDev includles all the details needed to display messages. This function allows developers to query the detailed error message.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
by​HashString

The hash String of the operation.

-
completion@escaping ((Better​Call​Dev​Operation​Error?, Kukai​Error?) -> Void)

Called with the result.

-
-
-
- - - -
-
- - - - diff --git a/BetterCallDevClient_BetterCallDevClientError/index.html b/BetterCallDevClient_BetterCallDevClientError/index.html deleted file mode 100644 index 640bf25c..00000000 --- a/BetterCallDevClient_BetterCallDevClientError/index.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - KukaiCoreSwift - BetterCallDevClient.BetterCallDevClientError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Better​Call​Dev​Client.​Better​Call​Dev​Client​Error -

- -
-
public enum BetterCallDevClientError: Error  
-
-
-

Dedicated BCD errors

- -
-
- -
- - - - - - -%323 - - - -BetterCallDevClient.BetterCallDevClientError - - -BetterCallDevClient.BetterCallDevClientError - - - - - -Error - -Error - - - -BetterCallDevClient.BetterCallDevClientError->Error - - - - - - - - -
-

Member Of

-
-
BetterCallDevClient
-

BetterCallDev (BCD) is an indexer/smart contract debugging tool, used for the Tezos blockchain. -This class allows developers to interact with their API, to fetch data that would otherwise be impossible for a mobile app to fetch from the Tezos RPC

-
-
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- invalid​URL -

-
-
case invalidURL
-
-
-
-

- parse​Error -

-
-
case parseError(String) 
-
-
-
- - - -
-
- - - - diff --git a/BetterCallDevOperation/index.html b/BetterCallDevOperation/index.html deleted file mode 100644 index aaaaca17..00000000 --- a/BetterCallDevOperation/index.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - KukaiCoreSwift - BetterCallDevOperation - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Better​Call​Dev​Operation -

- -
-
public struct BetterCallDevOperation: Codable  
-
-
-

A model matching the response that comes back from BetterCallDev's API: v1/opg/<operation-hash>

- -
-
- -
- - - - - - -%255 - - - -BetterCallDevOperation - - -BetterCallDevOperation - - - - - -Codable - -Codable - - - -BetterCallDevOperation->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- id -

-
-
public let id: Int
-
-
-

An ID used by BCD

- -
-
-
-

- hash -

-
-
public let hash: String
-
-
-

The operation hash

- -
-
-
-

- counter -

-
-
public let counter: Int
-
-
-

The operations numeric counter

- -
-
-
-

- status -

-
-
public let status: String
-
-
-

Indicating if the operation was successful, failed, backtracked etc.

- -
-
-
-

- errors -

-
-
public let errors: [BetterCallDevOperationError]? 
-
-
-

Detailed error objects, also including unique smart contract errors

- -
-
-
-
-

Methods

- -
-

- is​Failed() -

-
-
public func isFailed() -> Bool  
-
-
-

Helper to determine if the operation failed or not

- -
-
-
-

- contains​Error() -

-
-
public func containsError() -> Bool  
-
-
-

Helper to check for existance of errors

- -
-
-
-

- more​Detailed​Error() -

-
-
public func moreDetailedError() -> BetterCallDevOperationError?  
-
-
-

When looking for more detailed errors through Better-Call.dev, effectively we are looking for an error containing a location and/or a with. -We already have the other bits, but only location and with can identify the specific Dexter error

- -
-
-
- - - -
-
- - - - diff --git a/BetterCallDevOperationError/index.html b/BetterCallDevOperationError/index.html deleted file mode 100644 index fde350ab..00000000 --- a/BetterCallDevOperationError/index.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - KukaiCoreSwift - BetterCallDevOperationError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Better​Call​Dev​Operation​Error -

- -
-
public struct BetterCallDevOperationError: Codable  
-
-
-

BetterCallDev structure for errors

- -
-
- -
- - - - - - -%105 - - - -BetterCallDevOperationError - - -BetterCallDevOperationError - - - - - -Codable - -Codable - - - -BetterCallDevOperationError->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- id -

-
-
public let id: String
-
-
-
-

- title -

-
-
public let title: String
-
-
-
-

- descr -

-
-
public let descr: String
-
-
-
-

- kind -

-
-
public let kind: String
-
-
-
-

- location -

-
-
public let location: Int? 
-
-
-
-

- with -

-
-
public let with: String? 
-
-
-
- - - -
-
- - - - diff --git a/BetterCallDevTokenMetadata/index.html b/BetterCallDevTokenMetadata/index.html deleted file mode 100644 index 810c2917..00000000 --- a/BetterCallDevTokenMetadata/index.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - KukaiCoreSwift - BetterCallDevTokenMetadata - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Better​Call​Dev​Token​Metadata -

- -
-
public class BetterCallDevTokenMetadata: Codable  
-
-
-

A model matching the response that comes back from BetterCallDev's API: v1/tokens/<network>/metadata?contract=<address>

- -
-
- -
- - - - - - -%527 - - - -BetterCallDevTokenMetadata - - -BetterCallDevTokenMetadata - - - - - -Codable - -Codable - - - -BetterCallDevTokenMetadata->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- contract -

-
-
public let contract: String
-
-
-
-

- network -

-
-
public let network: String
-
-
-
-

- token_id -

-
-
public let token_id: Int
-
-
-
-

- symbol -

-
-
public let symbol: String? 
-
-
-
-

- name -

-
-
public let name: String? 
-
-
-
-

- decimals -

-
-
public let decimals: Int
-
-
-
-

- fa​Version -

-
-
public var faVersion: FaVersion? 
-
-
-
-

- image​URL -

-
-
public var imageURL: URL? 
-
-
-
- - - -
-
- - - - diff --git a/BiometricType/index.html b/BiometricType/index.html deleted file mode 100644 index 42f25edd..00000000 --- a/BiometricType/index.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - KukaiCoreSwift - BiometricType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Biometric​Type -

- -
-
public enum BiometricType  
-
- -
-

Enumeration Cases

- -
-

- unavailable -

-
-
case unavailable
-
-
-
-

- none -

-
-
case none
-
-
-
-

- touch​ID -

-
-
case touchID
-
-
-
-

- face​ID -

-
-
case faceID
-
-
-
- - - -
-
- - - - diff --git a/BlockchainHead/index.html b/BlockchainHead/index.html deleted file mode 100644 index bbb67865..00000000 --- a/BlockchainHead/index.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - KukaiCoreSwift - BlockchainHead - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Blockchain​Head -

- -
-
public struct BlockchainHead: Codable  
-
-
-

Structure representing the HEAD of the blockchain

- -
-
- -
- - - - - - -%275 - - - -BlockchainHead - - -BlockchainHead - - - - - -Codable - -Codable - - - -BlockchainHead->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- `protocol` -

-
-
public let `protocol`: String
-
-
-

The current protocol version string

- -
-
-
-

- chain​ID -

-
-
public let chainID: String
-
-
-

The current chainID being used

- -
-
-
-

- hash -

-
-
public let hash: String
-
-
-

The current hash or branch being used

- -
-
-
- - - -
-
- - - - diff --git a/CacheType/index.html b/CacheType/index.html deleted file mode 100644 index f725a429..00000000 --- a/CacheType/index.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - KukaiCoreSwift - CacheType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Cache​Type -

- -
-
public enum CacheType  
-
- -
-

Enumeration Cases

- -
-

- temporary -

-
-
case temporary
-
-
-
-

- permanent -

-
-
case permanent
-
-
-
- - - -
-
- - - - diff --git a/Classes.html b/Classes.html new file mode 100644 index 00000000..45246ca2 --- /dev/null +++ b/Classes.html @@ -0,0 +1,1969 @@ + + + + Classes Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Classes

+

The following classes are available globally.

+ +
+
+
+
    +
  • +
    + + + + BetterCallDevClient + +
    +
    +
    +
    +
    +
    +

    BetterCallDev (BCD) is an indexer/smart contract debugging tool, used for the Tezos blockchain. +This class allows developers to interact with their API, to fetch data that would otherwise be impossible for a mobile app to fetch from the Tezos RPC

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class BetterCallDevClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupClient + +
    +
    +
    +
    +
    +
    +

    This client exposes functions to allow communication to the indexer platform DipDup ( https://dipdup.net/ ). +DipDup is composed of many small, dedicated indexers, powered by GraphQL. This client tries to exposes userflow functions, allowing users to accomplish tasks without having to worry about the underlying complexities

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class DipDupClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktClient + +
    +
    +
    +
    +
    +
    +

    Client for interacting with the API of the popular NFT marketplace, OBJKT.com +Client exposes functions for fetching metadata, pricing, purchase offers, listing etc

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class ObjktClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosDomainsClient + +
    +
    +
    +
    +
    +
    +

    A client class allowing integration with the tezos domains GraphQL API. See more here: https://tezos.domains/

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TezosDomainsClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosNodeClient + +
    +
    +
    +
    +
    +
    +

    The TezosNodeClient offers methods for interacting with the Tezos node to fetch balances, send transactions etc. +The client will abstract away all the compelx tasks of remote forging, parsing, signing, preapply and injecting operations. +It will also convert amounts from the network into Token objects to make common tasks easier.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TezosNodeClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTClient + +
    +
    +
    +
    +
    +
    +

    TzKT is an indexer for Tezos, who’s API allows developers to query details about wallets, transactions, bakers, account status etc

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TzKTClient
    +
    extension TzKTClient: HubConnectionDelegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationFactory + +
    +
    +
    +
    +
    +
    +

    Class responsible for creating operations necessary to perform a given action, and converting those operations into the single payload expected by the RPC. +Although not every action requires more than one operation, all functions will return an array, for consistency.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationFactory
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A model matching the response that comes back from BetterCallDev’s API: v1/tokens/<network>/metadata?contract=<address>

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class BetterCallDevTokenMetadata : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + HDWallet + +
    +
    +
    +
    +
    +
    +

    A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

    + +

    This wallet is a HD wallet, allowing the creation of many child wallets from the one base privateKey. It also follows the Bip39 stnadard for generation via a mnemonic.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class HDWallet : Wallet
    +
    extension HDWallet: Equatable
    +
    extension HDWallet: Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LedgerWallet + +
    +
    +
    +
    +
    +
    +

    A Tezos wallet class, used to cache infomration regarding the paired ledger device used to sign the payload. +This class can only be created by fetching data from a Ledger device and supplying this data to the constructor.

    + +

    It is not possible to call the async sign function of this class, it will return null. Signing with a ledger is a complicated async process. +Please use the LedgerService class to setup a bluetooth connection, connect to the device and request a payload signing.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class LedgerWallet : Wallet
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Operation + +
    +
    +
    +
    +
    +
    +

    Base class representing an Operation on the Tezos network. On its own this class can’t be sent to the network. See its subclasses for more info.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class Operation : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Operation subclass for revealing a publickey to the network.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationActivateAccount : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationBallot + +
    +
    +
    +
    +
    +
    +

    Operation to submit a ballot on an upcoming proposal

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationBallot : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationDelegation + +
    +
    +
    +
    +
    +
    +

    Operation subclass for delegating an account to a baker

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationDelegation : Operation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Operation to report a baking of baking the same block twice

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationDoubleBakingEvidence : Operation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Operation to report a baker trying to endorse a block twice

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationDoubleEndorsementEvidence : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationEndorsement + +
    +
    +
    +
    +
    +
    +

    Operation for endorsing a block

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationEndorsement : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationOrigination + +
    +
    +
    +
    +
    +
    +

    Operation subclass for originating a contract on the Tezos network

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationOrigination : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationProposals + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationProposals : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationReveal + +
    +
    +
    +
    +
    +
    +

    Operation subclass for revealing a publickey to the network.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationReveal : Operation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Operation to reveal seed nonce to blockchain

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationSeedNonceRevelation : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationTransaction + +
    +
    +
    +
    +
    +
    +

    Operation subclass for sending XTZ to a destination

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationTransaction : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + RPC + +
    +
    +
    +
    +
    +
    +

    A generic class representing an RPC call to the Tezos network. +A type must be passed in when creating an instance of this object, this will be used by the network layer to parse the response and detect errors.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class RPC<T> where T : Decodable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + RegularWallet + +
    +
    +
    +
    +
    +
    +

    A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

    + +

    This wallet is a non-HD wallet, sometimes referred to as a “legacy” wallet. It follows the Bip39 standard for generation via menmonic.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class RegularWallet : Wallet
    +
    extension RegularWallet: Equatable
    +
    extension RegularWallet: Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Token + +
    +
    +
    +
    +
    +
    +

    A class to represent a Token on the Tezos network. This class will do all the heavy lifting of converting values from the RPC to more human readbale values. +This class will also handle arithmetic functions, allowing developers to add and subtract tokens (useful when caluclating fees and total values).

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class Token : Codable, CustomStringConvertible
    +
    extension Token: Equatable
    +
    extension Token: Hashable
    +
    extension Token: Identifiable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TokenAmount + +
    +
    +
    +
    +
    +
    +

    Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length. +This class is used to encapsulate a BigInt and provide all the necessary init’s and formatting functions to work with the networks requirements.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TokenAmount : Codable
    +
    extension TokenAmount: Comparable
    +
    extension TokenAmount: Equatable
    +
    extension TokenAmount: CustomStringConvertible
    +
    extension TokenAmount: Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TorusWallet + +
    +
    +
    +
    +
    +
    +

    A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

    + +

    This wallet is a subclass of LinearWallet created by using the Torus network to generate wallets from social media accounts. +This class is equivalent to a LinearWallet producing a TZ2 address via secp256k1, without the use of a mnemonic, and instead including the social profile of the user.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TorusWallet : RegularWallet
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + XTZAmount + +
    +
    +
    +
    +
    +
    +

    A subclass of TokenAmount to make it more explict when functions require XTZ (such as network fees). +It also serves as a means to more quickly create TokenAmount‘s conforming to XTZ.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class XTZAmount : TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DAppHelperService + +
    +
    +
    +
    +
    +
    +

    A Helper service to simply combine multiple calls from other services, and/or map to specific responses, in order to expose a piece of functionality provided by a dApp

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class DAppHelperService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DexCalculationService + +
    +
    +
    +
    +
    +
    +

    Wrapper around the kukai-dex-calculations JS library for performing calculations: https://github.com/kukai-wallet/kukai-dex-calculations

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class DexCalculationService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DiskService + +
    +
    +
    +
    +
    +
    +

    A service class to write and read data from the devices documents directory

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class DiskService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Service class +

+
+
+
    +
  • +
    + + + + ErrorHandlingService + +
    +
    +
    +
    +
    +
    +

    A class used to process errors into more readable format, and optionally notifiy a global error handler of every error occuring

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class ErrorHandlingService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FeeEstimatorService + +
    +
    +
    +
    +
    +
    +

    An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker. +This avoids the need to ask users to enter a fee, which is not a very user friendly approach as most users wouldn’t know what is required.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class FeeEstimatorService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LedgerService + +
    +
    +
    +
    +
    +
    +

    A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

    + +

    Ledger only provide a ReactNative module for third parties to integrate with. The architecture of the module also makes it very difficult to +integrate with native mobile (if it can be packaged up) as it relies heavily on long observable chains passing through many classes and functions. +To overcome this, I copied the base logic from multiple ledgerjs classes into a single typescript file and split the functions up into more of a utility style class, where +each function returns a result, that must be passed into another function. This allowed the creation of a swift class to sit in the middle of these +functions and decide what to do with the responses.

    + +

    The modified typescript can be found in this file (under a fork of the main repo) https://github.com/simonmcl/ledgerjs/blob/native-mobile/packages/hw-app-tezos/src/NativeMobileTezos.ts . +The containing package also includes a webpack file, which will package up the typescript and its dependencies into mobile friendly JS file, which +needs to be included in the swift project. Usage of the JS can be seen below.

    + +

    NOTE: this modified typescript is Tezos only as I was unable to find a way to simply subclass their Transport class, to produce a re-usable +NativeMobile transport. The changes required modifiying the app and other class logic which became impossible to refactor back into the project, without rewriting everything.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class LedgerService : NSObject, CBPeripheralDelegate, CBCentralManagerDelegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + MediaProxyService + +
    +
    +
    +
    +
    +
    +

    A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class MediaProxyService : NSObject
    +
    extension MediaProxyService: URLSessionDownloadDelegate
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class ContentTypeCheckingImageDownloader : ImageDownloader
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NetworkService + +
    +
    +
    +
    +
    +
    +

    Class responsible for sending all the networking requests, checking for http errors, RPC errors, Decoding the responses and optionally logging progress

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class NetworkService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationService + +
    +
    +
    +
    +
    +
    +

    Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TaquitoService + +
    +
    +
    +
    +
    +
    +

    Taquito (https://github.com/ecadlabs/taquito) is a popular open source Tezos library written in Typescript and Javascript. +Taquito is made up of many separate packages that deal with various aspects of Tezos RPC and Michelson. +This serivce class is a wrapper around a small piece of the Taquito library to expose funtionality that would otherwise be time consuming/risky/dangerous to re-implement natively. +The JS can now be found on each github release here: https://github.com/ecadlabs/taquito/releases/, by extracting the zip named “taquito-local-forging-vanilla.zip”

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TaquitoService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + TorusAuthService + +
    +
    +
    +
    +
    +
    +

    TorusAuthService is a wrapper around the SDK provided by: https://tor.us/ to allow the creation of TorusWallet‘s. +This allows users to create a wallet from their social media accounts without having to use a seed phrase / mnemonic. +TorusAuthService allows Tezos apps to leverage this service for a number of providers, and also has the ability to query the network for someone else’s wallet address, +based on their social profile. This allows you to send XTZ or tokens to your friend based on their twitter username for example

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TorusAuthService : NSObject
    +
    extension TorusAuthService: ASAuthorizationControllerDelegate, ASAuthorizationControllerPresentationContextProviding
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + WalletCacheService + +
    +
    +
    +
    +
    +
    +

    A service class used to store and retrieve Wallet objects such as RegularWallet, HDWallet, LedgerWallet and TorusWallet from the devices disk. +This class will use the secure enclave (keychain if not available) to generate a key used to encrypt the contents locally, and retrieve. +This class will also store non senstiivve “metadata” about wallets, to allow storage of UI related data users might want to add, without cluttering up the wallet objects themselves

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class WalletCacheService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/BetterCallDevClient.html b/Classes/BetterCallDevClient.html new file mode 100644 index 00000000..9e998e2f --- /dev/null +++ b/Classes/BetterCallDevClient.html @@ -0,0 +1,913 @@ + + + + BetterCallDevClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevClient

+
+
+ +
public class BetterCallDevClient
+ +
+
+

BetterCallDev (BCD) is an indexer/smart contract debugging tool, used for the Tezos blockchain. +This class allows developers to interact with their API, to fetch data that would otherwise be impossible for a mobile app to fetch from the Tezos RPC

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Dedicated BCD errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum BetterCallDevClientError : Error
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Errors +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Primarily the TzKTClient is used to fetch details on operations. However for more complex calls involving smart contracts, TzKT will only return limited error message info. +BetterCallDev includles all the details needed to display messages. This function allows developers to query the detailed error message.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getMoreDetailedError(byHash hash: String, completion: @escaping ((BetterCallDevOperationError?, KukaiError?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + byHash + + +
    +

    The hash String of the operation.

    +
    +
    + + completion + + +
    +

    Called with the result.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/BetterCallDevClient/BetterCallDevClientError.html b/Classes/BetterCallDevClient/BetterCallDevClientError.html new file mode 100644 index 00000000..3bc038f4 --- /dev/null +++ b/Classes/BetterCallDevClient/BetterCallDevClientError.html @@ -0,0 +1,793 @@ + + + + BetterCallDevClientError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevClientError

+
+
+ +
public enum BetterCallDevClientError : Error
+ +
+
+

Dedicated BCD errors

+ +
+
+
+
    +
  • +
    + + + + invalidURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidURL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseError(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parseError(String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/BetterCallDevTokenMetadata.html b/Classes/BetterCallDevTokenMetadata.html new file mode 100644 index 00000000..89fc4b51 --- /dev/null +++ b/Classes/BetterCallDevTokenMetadata.html @@ -0,0 +1,949 @@ + + + + BetterCallDevTokenMetadata Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevTokenMetadata

+
+
+ +
public class BetterCallDevTokenMetadata : Codable
+ +
+
+

A model matching the response that comes back from BetterCallDev’s API: v1/tokens/<network>/metadata?contract=<address>

+ +
+
+
+
    +
  • +
    + + + + contract + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contract: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + network + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let network: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + token_id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token_id: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimals + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let decimals: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + faVersion + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var faVersion: FaVersion?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + imageURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var imageURL: URL?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/ContentTypeCheckingImageDownloader.html b/Classes/ContentTypeCheckingImageDownloader.html new file mode 100644 index 00000000..aa445f17 --- /dev/null +++ b/Classes/ContentTypeCheckingImageDownloader.html @@ -0,0 +1,766 @@ + + + + ContentTypeCheckingImageDownloader Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ContentTypeCheckingImageDownloader

+
+
+ +
public class ContentTypeCheckingImageDownloader : ImageDownloader
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func startDownloadTask(context: DownloadingContext, callback: SessionDataTask.TaskCallback) -> DownloadTask
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/DAppHelperService.html b/Classes/DAppHelperService.html new file mode 100644 index 00000000..2091d82c --- /dev/null +++ b/Classes/DAppHelperService.html @@ -0,0 +1,769 @@ + + + + DAppHelperService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DAppHelperService

+
+
+ +
public class DAppHelperService
+ +
+
+

A Helper service to simply combine multiple calls from other services, and/or map to specific responses, in order to expose a piece of functionality provided by a dApp

+ +
+
+
+
    +
  • +
    + + + + Quipuswap + +
    +
    +
    +
    +
    +
    +

    All functions related to Quipuswap

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Quipuswap
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/DAppHelperService/Quipuswap.html b/Classes/DAppHelperService/Quipuswap.html new file mode 100644 index 00000000..738d0b34 --- /dev/null +++ b/Classes/DAppHelperService/Quipuswap.html @@ -0,0 +1,952 @@ + + + + Quipuswap Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Quipuswap

+
+
+ +
public struct Quipuswap
+ +
+
+

All functions related to Quipuswap

+ +
+
+
+
+ + +
+ +

Quipuswap Constants +

+
+
+ +
+
+
+ + +
+ +

Quipuswap Functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Use TzKTClient’s methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getPendingRewards(fromExchange exchange: String, forAddress address: String, tzKTClient: TzKTClient, completion: @escaping ((Result<XTZAmount, KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper around getPendingRewards(..., completion: ) to make it easier to create bulk queries, through combine

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getPendingRewards(fromExchange exchange: String, forAddress address: String, tzKTClient: TzKTClient) -> Future<(exchange: String, rewards: XTZAmount), KukaiError>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Use TzKTClient’s methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getBulkPendingRewards(fromExchanges exchanges: [String], forAddress address: String, tzKTClient: TzKTClient, completion: @escaping ((Result<[(exchange: String, rewards: XTZAmount)], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/DexCalculationService.html b/Classes/DexCalculationService.html new file mode 100644 index 00000000..a65d53e5 --- /dev/null +++ b/Classes/DexCalculationService.html @@ -0,0 +1,2808 @@ + + + + DexCalculationService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DexCalculationService

+
+
+ +
public class DexCalculationService
+ +
+
+

Wrapper around the kukai-dex-calculations JS library for performing calculations: https://github.com/kukai-wallet/kukai-dex-calculations

+ +
+
+
+
    +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Public shared instace to avoid having multiple copies of the underlying JSContext created

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let shared: DexCalculationService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

User flow functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for a xtzToToken exchange, to perform the operation and display the info to the user in a confirmation screen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateXtzToToken(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexSwapCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex contract holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex contract holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    DexSwapCalculationResult containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for a tokenToXtz exchange, to perform the operation and display the info to the user in a confirmation screen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateTokenToXTZ(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexSwapCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex contract holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex contract holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    DexSwapCalculationResult containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for adding liquidity, with an XTZ input

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateAddLiquidity(xtz: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, totalLiquidity: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexAddCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + xtz + + +
    +

    The amount of XTZ to deposit

    +
    +
    + + xtzPool + + +
    +

    The total XTZ held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The total token held in the dex contract

    +
    +
    + + totalLiquidity + + +
    +

    The ttotal liquidity held in the liquidity contract

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    (tokenRequired: TokenAmount, liquidity: TokenAmount) containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for adding liquidity, with an Token input

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateAddLiquidity(token: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, totalLiquidity: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexAddCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + token + + +
    +

    The amount of Token to deposit

    +
    +
    + + xtzPool + + +
    +

    The total XTZ held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The total token held in the dex contract

    +
    +
    + + totalLiquidity + + +
    +

    The ttotal liquidity held in the liquidity contract

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    (xtzRequired: XTZAmount, liquidity: TokenAmount) containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for removing liquidity, to return everything the user will get out

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateRemoveLiquidity(liquidityBurned: TokenAmount, totalLiquidity: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexRemoveCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + liquidityBurned + + +
    +

    The amount of Liquidity tokens the user wants to burn or sell

    +
    +
    + + totalLiquidity + + +
    +

    The total volume of liquidity held in the contract

    +
    +
    + + xtzPool + + +
    +

    The xtz pool held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The token pool held in the dex contract

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    (xtz: XTZAmount, token: TokenAmount) containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • +
    + + + + settings(forDex:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func settings(forDex dex: DipDupExchangeName) -> (fee: Double, burn: Double, includeSubsidy: Bool)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

XTZ To Token +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The TokenAmount expected to be returned for the supplied XTZAmount, given the dex contract xtzPool and tokenPool.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenExpectedReturn(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> TokenAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount containing the amount the user can expect in return for their XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The minimum possible TokenAmount returned, taking into account slippage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenMinimumReturn(tokenAmount: TokenAmount, slippage: Double) -> TokenAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + tokenAmount + + +
    +

    The TokenAmount returned from xtzToTokenExpectedReturn().

    +
    +
    + + slippage + + +
    +

    A double value between 0 and 1, indicating the maximum percentage of slippage a user will accept.

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount containing the minimum amount the user can expect in return for their XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the XTZAmount required in order to receive the supplied TokenAmount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenRequiredXtzFor(tokenAmount: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> XTZAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenAmount + + +
    +

    The TokenAmount the user wants to receive.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount containing the amount of XTZ required in order to recieve the amount of token.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

XTZ To Token Rates +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The exchange rate for a given trade, taking into account slippage and fees

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenExchangeRate(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 XTZ to the requested Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenExchangeRateDisplay(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 XTZ to the requested Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenMarketRate(xtzPool: XTZAmount, tokenPool: TokenAmount) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 XTZ to the requested Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calcualte the percentage the price impact the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenPriceImpact(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the slippage percentage, 0 - 100.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Token to XTZ +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The XTZAmount expected to be returned for the supplied TokenAmount, given the dex contracts xtzPool and tokenPool.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzExpectedReturn(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> XTZAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount containing the amount the user can expect in return for their Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The minimum possible XTZAmount returned, taking into account slippage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzMinimumReturn(xtzAmount: XTZAmount, slippage: Double) -> XTZAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + xtzAmount + + +
    +

    The XTZAmount returned from tokenToXtzExpectedReturn().

    +
    +
    + + slippage + + +
    +

    A double value between 0 and 1, indicating the maximum percentage of slippage a user will accept.

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount containing the minimum amount the user can expect in return for their Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the TokenAmount required in order to receive the supplied XTZAmount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzRequiredTokenFor(xtzAmount: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> TokenAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzAmount + + +
    +

    The XTZAmount the user wants to receive.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount containing the amount of Token required in order to recieve the amount of XTZ.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

XTZ To Token Rates +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The exchange rate for a given trade, taking into account slippage and fees

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzExchangeRate(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 of the given Token to XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzExchangeRateDisplay(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 of the given Token to XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzMarketRate(xtzPool: XTZAmount, tokenPool: TokenAmount) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 of the given Token to XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calcualte the percentage slippage the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzPriceImpact(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the slippage percentage, 0 - 100.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Add Liquidity +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of liquidity tokens a user can expect back for an amount of XTZ and Token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func addLiquidityReturn(xtzToDeposit: XTZAmount, xtzPool: XTZAmount, totalLiquidity: TokenAmount, slippage: Double, dex: DipDupExchangeName) -> (expected: TokenAmount, minimum: TokenAmount)?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + xtzToDeposit + + +
    +

    The XTZ to send to the dex contract

    +
    +
    + + tokenToDeposit + + +
    +

    The Token to send to the dex contract

    +
    +
    + + totalLiquidity + + +
    +

    The total liquidity already in the contract

    +
    +
    + + slippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount an amount of Liquidity token you will receive

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of Token that is required to send along side your XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func addLiquidityTokenRequired(xtzToDeposit: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> TokenAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToDeposit + + +
    +

    The amount of XTZ to send

    +
    +
    + + xtzPool + + +
    +

    The XTZ currently held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The Token currently held in the dex contract

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount The amount of token required to send with the given amount of XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of XTZ that is required to send along side your Token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func addLiquidityXtzRequired(tokenToDeposit: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> XTZAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToDeposit + + +
    +

    The amount of Token to send

    +
    +
    + + xtzPool + + +
    +

    The XTZ currently held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The Token currently held in the dex contract

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount The amount of XTZ required to send with the given amount of Token

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Remove Liquidity +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of token a user would revice back if they burned X liquidity

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func removeLiquidityTokenReceived(liquidityBurned: TokenAmount, totalLiquidity: TokenAmount, tokenPool: TokenAmount, slippage: Double) -> (expected: TokenAmount, minimum: TokenAmount)?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + liquidityBurned + + +
    +

    The amount of liquidity to burn

    +
    +
    + + totalLiquidity + + +
    +

    The totla liquidity held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The total token held in the dex contract

    +
    +
    + + slippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount The amount of Token that would be returned

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of XTZ a user would revice back if they burned X liquidity

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func removeLiquidityXtzReceived(liquidityBurned: TokenAmount, totalLiquidity: TokenAmount, xtzPool: XTZAmount, slippage: Double, dex: DipDupExchangeName) -> (expected: XTZAmount, minimum: XTZAmount)?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + liquidityBurned + + +
    +

    The amount of liquidity to burn

    +
    +
    + + totalLiquidity + + +
    +

    The totla liquidity held in the dex contract

    +
    +
    + + xtzPool + + +
    +

    The total XTZ held in the dex contract

    +
    +
    + + slippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount The amount of XTZ that would be returned

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Misc +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Estimate the APY of liquidity baking contract, as it has a known income.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func estimateLiquidityBakingAPY(xtzPool: XTZAmount) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + xtzPool + + +
    +

    The total XTZ held in the dex contract

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal The estimated percentage APY

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/DipDupClient.html b/Classes/DipDupClient.html new file mode 100644 index 00000000..6f7487bb --- /dev/null +++ b/Classes/DipDupClient.html @@ -0,0 +1,1085 @@ + + + + DipDupClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupClient

+
+
+ +
public class DipDupClient
+ +
+
+

This client exposes functions to allow communication to the indexer platform DipDup ( https://dipdup.net/ ). +DipDup is composed of many small, dedicated indexers, powered by GraphQL. This client tries to exposes userflow functions, allowing users to accomplish tasks without having to worry about the underlying complexities

+ +
+
+
+
    +
  • +
    + + + + dexMaxQuerySize + +
    +
    +
    +
    +
    +
    +

    Max enteries to return per request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let dexMaxQuerySize: Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Public functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get a list of all the tokens available and on what excahnges (including their prices and pool data)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getExchangesAndTokens(limit: Int = DipDupClient.dexMaxQuerySize, offset: Int = 0, completion: @escaping ((Result<GraphQLResponse<DipDupExchangesAndTokensResponse>, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + limit + + +
    +

    Int, How many results to reuturn 100 Max)

    +
    +
    + + offset + + +
    +

    Int, How many positions to move the cursor

    +
    +
    + + completion + + +
    +

    Block returning a GraphQL response or an KukaiError

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Recurrsively call getExchangesAndTokens(...) until we have found all the tokens

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAllExchangesAndTokens(completion: @escaping ((Result<[DipDupExchangesAndTokens], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    Block returning a GraphQL response or an KukaiError

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Query a given addresses liquidity token balances

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getLiquidityFor(address: String, completion: @escaping ((Result<GraphQLResponse<DipDupPosition>, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + address + + +
    +

    The TZ address to query for

    +
    +
    + + completion + + +
    +

    Block returning a GraphQL response or an KukaiError

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Query a given contract address for pricing data for the given token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getChartDataFor(exchangeContract: String, nowDate: Date = Date(), completion: @escaping ((Result<GraphQLResponse<DipDupChartData>, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + exchangeContract + + +
    +

    The KT address of the dex contract to query data for

    +
    +
    + + completion + + +
    +

    Block returning a GraphQL response or an KukaiError

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/DiskService.html b/Classes/DiskService.html new file mode 100644 index 00000000..6640f575 --- /dev/null +++ b/Classes/DiskService.html @@ -0,0 +1,1051 @@ + + + + DiskService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DiskService

+
+
+ +
public class DiskService
+ +
+
+

A service class to write and read data from the devices documents directory

+ +
+
+
+
+ + +
+ +

Write +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Write an instance of Data to a given fileName

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func write(data: Data, toFileName: String, isExcludedFromBackup: Bool = true) -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the operation was successful

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Write an instance of an object conforming to Encodable to a fileName

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func write<T>(encodable: T, toFileName: String, isExcludedFromBackup: Bool = true) -> Bool where T : Encodable
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the operation was successful

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Read +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Read a fileName and return the contents as Data

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func readData(fromFileName: String) -> Data?
    + +
    +
    +
    +

    Return Value

    +

    Data, if able to read file

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Read a fileName, and parse the contents as an instance of a Decodable object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func read<T>(type: T.Type, fromFileName: String) -> T? where T : Decodable
    + +
    +
    +
    +

    Return Value

    +

    An instance of the Decodable type, if able to read file and parse it

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Delete +

+
+
+
    +
  • +
    + + + + delete(fileName:) + +
    +
    +
    +
    +
    +
    +

    Delete a fileName

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func delete(fileName: String) -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the operation was successful

    +
    +
    +
    +
  • +
  • +
    + + + + delete(fileNames:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func delete(fileNames: [String]) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Utility +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get the URL to the devices documents directory, if possible

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func documentsDirectory(isExcludedFromBackup: Bool = true) -> URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exists(fileName:) + +
    +
    +
    +
    +
    +
    +

    Check if a fileName exists in the documents directory or not

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func exists(fileName: String) -> URL?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Find all files in documents directory begining with prefix

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func allFileNamesWith(prefix: String) -> [String]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/ErrorHandlingService.html b/Classes/ErrorHandlingService.html new file mode 100644 index 00000000..112a05b0 --- /dev/null +++ b/Classes/ErrorHandlingService.html @@ -0,0 +1,925 @@ + + + + ErrorHandlingService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ErrorHandlingService

+
+
+ +
public class ErrorHandlingService
+ +
+
+

A class used to process errors into more readable format, and optionally notifiy a global error handler of every error occuring

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Shared instance so that it can hold onto an event closure

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let shared: ErrorHandlingService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errorEventClosure + +
    +
    +
    +
    +
    +
    +

    Called everytime an error is parsed. Extremely useful to track / log errors globally, in order to run logic or record to external service

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var errorEventClosure: ((KukaiError) -> Void)?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Error parsers +

+
+
+ +
+
+
+ +
+
+ + diff --git a/Classes/FeeEstimatorService.html b/Classes/FeeEstimatorService.html new file mode 100644 index 00000000..acda85ea --- /dev/null +++ b/Classes/FeeEstimatorService.html @@ -0,0 +1,1360 @@ + + + + FeeEstimatorService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FeeEstimatorService

+
+
+ +
public class FeeEstimatorService
+ +
+
+

An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker. +This avoids the need to ask users to enter a fee, which is not a very user friendly approach as most users wouldn’t know what is required.

+ +
+
+
+
    +
  • +
    + + + + defaultSignature + +
    +
    +
    +
    +
    +
    +

    The real signature is not needed for estimation, use the default “Zero Signature” instead

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let defaultSignature: [UInt8]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + defaultSignatureHex + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let defaultSignatureHex: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + FeeConstants + +
    +
    +
    +
    +
    +
    +

    Constants needed to compute a fee

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct FeeConstants
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Various possible errors that can occur during an Estimation

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum FeeEstimatorServiceError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EstimationResult + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct EstimationResult : Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + config + +
    +
    +
    +
    +
    +
    +

    The configuration object containing all the necessary settings to connect and communicate with the Tezos node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let config: TezosNodeClientConfig
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationService + +
    +
    +
    +
    +
    +
    +

    The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operationService: OperationService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkService + +
    +
    +
    +
    +
    +
    +

    The NetworkService that will handle the remote communication.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let networkService: NetworkService
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a FeeEstimatorService that will allow developers to automatically create fees on the users behalf

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(config: TezosNodeClientConfig = TezosNodeClientConfig(withDefaultsForNetworkType: .mainnet), operationService: OperationService, networkService: NetworkService)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + operationService + + +
    +

    The OperationService used to perform the forging.

    +
    +
    + + networkService + + +
    +

    The NetworkService that will handle the remote communication.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Pass in an array of Operation subclasses (use OperationFacotry to create) to have the library estimate the cost of sending the transaction. Function will use local or remote forging based off config passed in. +If the supplied operations contain suggested fees (e.g. from a dApp) this function will estimate the fee and pick which ever is higher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func estimate(operations: [Operation], operationMetadata: OperationMetadata, constants: NetworkConstants, walletAddress: String, base58EncodedPublicKey: String, completion: @escaping ((Result<EstimationResult, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + operations + + +
    +

    An array of Operation subclasses to be estimated.

    +
    +
    + + operationMetadata + + +
    +

    An OperationMetadata object containing necessary info about the current blockchain state.

    +
    +
    + + networkConstants + + +
    +

    A NetworkConstants used to provide information about the current network requirements.

    +
    +
    + + withWallet + + +
    +

    The Wallet object used for signing the transaction.

    +
    +
    + + completion + + +
    +

    A callback containing the same operations passed in, modified to include fees.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an array of OperationFees from an OperationResponse.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func extractFees(fromOperationResponse operationResponse: OperationResponse, forgedHash: String, withConstants constants: NetworkConstants) -> [OperationFees]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + fromOperationResponse + + +
    +

    The OperationResponse resulting from an RPC call to .../run_operation.

    +
    +
    + + forgedHash + + +
    +

    The forged hash string resulting from a call to TezosNodeClient.forge(...)

    +
    +
    +
    +
    +

    Return Value

    +

    An array of OperationFees

    +
    +
    +
    +
  • +
  • +
    + + + + feeForGas(_:) + +
    +
    +
    +
    +
    +
    +

    Calculate the fee to add for the given amount of gas

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func feeForGas(_ gas: Int) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the fee to add based on the size of the forged string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func feeForStorage(_ forgedHexString: String, numberOfOperations: Int) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the fee to add based on how many bytes of storage where needed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func feeForBurn(_ burn: Int, withConstants contants: NetworkConstants) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nanoTeztoXTZ(_:) + +
    +
    +
    +
    +
    +
    +

    Most calcualtions are documented in NanoTez, which is not accpeted by the network RPC calls. Needs to be converted to Mutez / XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func nanoTeztoXTZ(_ nanoTez: NanoTez) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func fee(forGasLimit gasLimit: Int, forgedHexString: String, numberOfOperations: Int) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func addGasSafetyMarginTo(gasUsed: Int) -> Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/FeeEstimatorService/EstimationResult.html b/Classes/FeeEstimatorService/EstimationResult.html new file mode 100644 index 00000000..c715cd63 --- /dev/null +++ b/Classes/FeeEstimatorService/EstimationResult.html @@ -0,0 +1,792 @@ + + + + EstimationResult Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

EstimationResult

+
+
+ +
public struct EstimationResult : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + operations + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operations: [Operation]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + forgedString + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let forgedString: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/FeeEstimatorService/FeeConstants.html b/Classes/FeeEstimatorService/FeeConstants.html new file mode 100644 index 00000000..1ac465c7 --- /dev/null +++ b/Classes/FeeEstimatorService/FeeConstants.html @@ -0,0 +1,871 @@ + + + + FeeConstants Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FeeConstants

+
+
+ +
public struct FeeConstants
+ +
+
+

Constants needed to compute a fee

+ +
+
+
+
    +
  • +
    + + + + nanoTezPerMutez + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let nanoTezPerMutez: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + minimalFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let minimalFee: NanoTez
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + feePerGasUnit + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let feePerGasUnit: NanoTez
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + feePerStorageByte + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let feePerStorageByte: NanoTez
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + baseFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let baseFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/FeeEstimatorService/FeeEstimatorServiceError.html b/Classes/FeeEstimatorService/FeeEstimatorServiceError.html new file mode 100644 index 00000000..f2385821 --- /dev/null +++ b/Classes/FeeEstimatorService/FeeEstimatorServiceError.html @@ -0,0 +1,897 @@ + + + + FeeEstimatorServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FeeEstimatorServiceError

+
+
+ +
public enum FeeEstimatorServiceError : Error
+ +
+
+

Various possible errors that can occur during an Estimation

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Classes/HDWallet.html b/Classes/HDWallet.html new file mode 100644 index 00000000..bf096c5b --- /dev/null +++ b/Classes/HDWallet.html @@ -0,0 +1,1272 @@ + + + + HDWallet Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

HDWallet

+
+
+ +
public class HDWallet : Wallet
+
extension HDWallet: Equatable
+
extension HDWallet: Hashable
+ +
+
+

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

+ +

This wallet is a HD wallet, allowing the creation of many child wallets from the one base privateKey. It also follows the Bip39 stnadard for generation via a mnemonic.

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The underlying wallet type, set to .hd

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: WalletType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The public TZ1 address of the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKey + +
    +
    +
    +
    +
    +
    +

    An WalletCore object representing the PrivateKey used to generate the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var privateKey: PrivateKey
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    +

    An WalletCore object representing the PublicKey used to generate the wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var publicKey: PublicKey
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mnemonic + +
    +
    +
    +
    +
    +
    +

    The Bip39 mnemonic used to generate the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var mnemonic: Mnemonic
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + derivationPath + +
    +
    +
    +
    +
    +
    +

    The Bip44 derivationPath used to create the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var derivationPath: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a HDWallet by supplying a mnemonic string and a passphrase (or “” if none).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(withMnemonic mnemonic: Mnemonic, passphrase: String, derivationPath: String = HD.defaultDerivationPath)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + withMnemonic + + +
    +

    A Mnemonic representing a BIP39 menmonic

    +
    +
    + + passphrase + + +
    +

    String contianing a passphrase, or empty string if none

    +
    +
    + + derivationPath + + +
    +

    Optional: use a different derivation path to the default HDWallet.defaultDerivationPath

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a HDWallet by asking for a mnemonic of a given number of words and a passphrase (or “” if none).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(withMnemonicLength length: Mnemonic.NumberOfWords, passphrase: String, derivationPath: String = HD.defaultDerivationPath)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + withMnemonicLength + + +
    +

    Mnemonic.NumberOfWords the number of words to use when creating a mnemonic

    +
    +
    + + passphrase + + +
    +

    String contianing a passphrase, or empty string if none

    +
    +
    + + derivationPath + + +
    +

    Optional: use a different derivation path to the default HDWallet.defaultDerivationPath

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Crypto Functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Sign a hex payload with the private key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKeyCurve() + +
    +
    +
    +
    +
    +
    +

    Return the curve used to create the key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func privateKeyCurve() -> EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a Base58 encoded version of the public key, in order to reveal the address on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func publicKeyBase58encoded() -> String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The default implementation in Ledger is to not give users the option to provide their own derivation path, but instead increment the “account” field by 1 each time. +This function will create a new HDWallet, by taking the default derivation path and changing the account to the index supplied, and using the same key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func createChild(accountIndex: Int) -> HDWallet?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    This function will create a new HDWallet, by using the same key combined with the supplied derivationPath

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func createChild(derivationPath: String) -> HDWallet?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: HDWallet, rhs: HDWallet) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/LedgerService.html b/Classes/LedgerService.html new file mode 100644 index 00000000..e47bcac7 --- /dev/null +++ b/Classes/LedgerService.html @@ -0,0 +1,1456 @@ + + + + LedgerService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LedgerService

+
+
+ +
public class LedgerService : NSObject, CBPeripheralDelegate, CBCentralManagerDelegate
+ +
+
+

A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

+ +

Ledger only provide a ReactNative module for third parties to integrate with. The architecture of the module also makes it very difficult to +integrate with native mobile (if it can be packaged up) as it relies heavily on long observable chains passing through many classes and functions. +To overcome this, I copied the base logic from multiple ledgerjs classes into a single typescript file and split the functions up into more of a utility style class, where +each function returns a result, that must be passed into another function. This allowed the creation of a swift class to sit in the middle of these +functions and decide what to do with the responses.

+ +

The modified typescript can be found in this file (under a fork of the main repo) https://github.com/simonmcl/ledgerjs/blob/native-mobile/packages/hw-app-tezos/src/NativeMobileTezos.ts . +The containing package also includes a webpack file, which will package up the typescript and its dependencies into mobile friendly JS file, which +needs to be included in the swift project. Usage of the JS can be seen below.

+ +

NOTE: this modified typescript is Tezos only as I was unable to find a way to simply subclass their Transport class, to produce a re-usable +NativeMobile transport. The changes required modifiying the app and other class logic which became impossible to refactor back into the project, without rewriting everything.

+ +
+
+
+
+ + +
+ +

Types / Constants +

+
+
+
    +
  • +
    + + + + successCode + +
    +
    +
    +
    +
    +
    +

    Instead of returning data, sometimes ledger returns a code to indicate that so far the message have been received successfully

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let successCode: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + GeneralErrorCodes + +
    +
    +
    +
    +
    +
    +

    General Ledger error codes, pulled from the source, and some additional ones added for native swift issues

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum GeneralErrorCodes : String, Error, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosAppErrorCodes + +
    +
    +
    +
    +
    +
    +

    Dedicated error codes pulled from the Ledger tezos app

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TezosAppErrorCodes : String, Error, Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Be notified when the ledger device returns a success message, part way through the process. +This can be useful to indicate to users that the request has succeed, but s waiting on input on the Ledger device to continue

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    @Published
    +public var partialSuccessMessageReceived: Bool { get set }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Public shared instace to avoid having multiple copies of the underlying JSContext created

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let shared: LedgerService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public functions +

+
+
+
    +
  • +
    + + + + listenForDevices() + +
    +
    +
    +
    +
    +
    +

    Start listening for ledger devices

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func listenForDevices() -> AnyPublisher<[String : String], KukaiError>
    + +
    +
    +
    +

    Return Value

    +

    Publisher with a dictionary of [UUID: deviceName] or an KukaiError

    +
    +
    +
    +
  • +
  • +
    + + + + stopListening() + +
    +
    +
    +
    +
    +
    +

    Stop listening for and reporting new ledger devices found

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func stopListening()
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + connectTo(uuid:) + +
    +
    +
    +
    +
    +
    +

    Connect to a ledger device by a given UUID

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func connectTo(uuid: String) -> AnyPublisher<Bool, KukaiError>
    + +
    +
    +
    +

    Return Value

    +

    Publisher which will indicate true / false, or return an KukaiError if it can’t connect to bluetooth

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Disconnect from the current Ledger device

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func disconnectFromDevice()
    + +
    +
    +
    +

    Return Value

    +

    A Publisher with a boolean, or KukaiError if soemthing goes wrong

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the UUID of the connected device

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getConnectedDeviceUUID() -> String?
    + +
    +
    +
    +

    Return Value

    +

    a string if it can be found

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a TZ address and public key from the current connected Ledger device

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAddress(forDerivationPath derivationPath: String = HD.defaultDerivationPath, curve: EllipticalCurve = .ed25519, verify: Bool) -> AnyPublisher<(address: String, publicKey: String), KukaiError>
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + forDerivationPath + + +
    +

    Optional. The derivation path to use to extract the address from the underlying HD wallet

    +
    +
    + + curve + + +
    +

    Optional. The EllipticalCurve to use to extract the address

    +
    +
    + + verify + + +
    +

    Whether or not to ask the ledger device to prompt the user to show them what the TZ address should be, to ensure the mobile matches

    +
    +
    +
    +
    +

    Return Value

    +

    A publisher which will return a tuple containing the address and publicKey, or an KukaiError

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Sign an operation payload with the underlying secret key, returning the signature

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func sign(hex: String, forDerivationPath derivationPath: String = HD.defaultDerivationPath, parse: Bool) -> AnyPublisher<String, KukaiError>
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + hex + + +
    +

    An operation converted to JSON, forged and watermarked, converted to a hex string. (Note: there are some issues with the ledger app signing batch transactions. May simply return no result at all. Can’t run REVEAL and TRANSACTION together for example)

    +
    +
    + + forDerivationPath + + +
    +

    Optional. The derivation path to use to extract the address from the underlying HD wallet

    +
    +
    + + parse + + +
    +

    Ledger can parse non-hashed (blake2b) hex data and display operation data to user (e.g. transfer 1 XTZ to TZ1abc, for fee: 0.001). There are many limitations around what can be parsed. Frequnetly it will require passing in false

    +
    +
    +
    +
    +

    Return Value

    +

    A Publisher which will return a string containing the hex signature, or an KukaiError

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Bluetooth +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func centralManagerDidUpdateState(_ central: CBCentralManager)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func centralManager(_ central: CBCentralManager, didDiscover peripheral: CBPeripheral, advertisementData: [String : Any], rssi RSSI: NSNumber)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func centralManager(_ central: CBCentralManager, didConnect peripheral: CBPeripheral)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func centralManager(_ central: CBCentralManager, didFailToConnect peripheral: CBPeripheral, error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func peripheral(_ peripheral: CBPeripheral, didDiscoverServices error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func peripheral(_ peripheral: CBPeripheral, didDiscoverCharacteristicsFor service: CBService, error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func peripheral(_ peripheral: CBPeripheral, didWriteValueFor characteristic: CBCharacteristic, error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func peripheral(_ peripheral: CBPeripheral, didUpdateValueFor characteristic: CBCharacteristic, error: Error?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/LedgerService/GeneralErrorCodes.html b/Classes/LedgerService/GeneralErrorCodes.html new file mode 100644 index 00000000..ed2fbe05 --- /dev/null +++ b/Classes/LedgerService/GeneralErrorCodes.html @@ -0,0 +1,1599 @@ + + + + GeneralErrorCodes Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

GeneralErrorCodes

+
+
+ +
public enum GeneralErrorCodes : String, Error, Codable
+ +
+
+

General Ledger error codes, pulled from the source, and some additional ones added for native swift issues

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case PIN_REMAINING_ATTEMPTS = "63c0"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INCORRECT_LENGTH + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INCORRECT_LENGTH = "6700"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case MISSING_CRITICAL_PARAMETER = "6800"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case COMMAND_INCOMPATIBLE_FILE_STRUCTURE = "6981"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case SECURITY_STATUS_NOT_SATISFIED = "6982"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CONDITIONS_OF_USE_NOT_SATISFIED = "6985"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INCORRECT_DATA + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INCORRECT_DATA = "6a80"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case NOT_ENOUGH_MEMORY_SPACE = "6a84"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case REFERENCED_DATA_NOT_FOUND = "6a88"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FILE_ALREADY_EXISTS + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case FILE_ALREADY_EXISTS = "6a89"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INCORRECT_P1_P2 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INCORRECT_P1_P2 = "6b00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INS_NOT_SUPPORTED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INS_NOT_SUPPORTED = "6d00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CLA_NOT_SUPPORTED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CLA_NOT_SUPPORTED = "6e00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TECHNICAL_PROBLEM + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case TECHNICAL_PROBLEM = "6f00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + MEMORY_PROBLEM + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case MEMORY_PROBLEM = "9240"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NO_EF_SELECTED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case NO_EF_SELECTED = "9400"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INVALID_OFFSET + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INVALID_OFFSET = "9402"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FILE_NOT_FOUND + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case FILE_NOT_FOUND = "9404"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INCONSISTENT_FILE + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INCONSISTENT_FILE = "9408"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ALGORITHM_NOT_SUPPORTED = "9484"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INVALID_KCV + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INVALID_KCV = "9485"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CODE_NOT_INITIALIZED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CODE_NOT_INITIALIZED = "9802"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ACCESS_CONDITION_NOT_FULFILLED = "9804"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CONTRADICTION_SECRET_CODE_STATUS = "9808"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CONTRADICTION_INVALIDATION = "9810"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CODE_BLOCKED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CODE_BLOCKED = "9840"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + MAX_VALUE_REACHED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case MAX_VALUE_REACHED = "9850"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + GP_AUTH_FAILED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case GP_AUTH_FAILED = "6300"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LICENSING + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case LICENSING = "6f42"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + HALTED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case HALTED = "6faa"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DEVICE_LOCKED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case DEVICE_LOCKED = "009000"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + UNKNOWN + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case UNKNOWN = "99999999"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case NO_WRITE_CHARACTERISTIC = "99999996"
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/LedgerService/TezosAppErrorCodes.html b/Classes/LedgerService/TezosAppErrorCodes.html new file mode 100644 index 00000000..836b6c50 --- /dev/null +++ b/Classes/LedgerService/TezosAppErrorCodes.html @@ -0,0 +1,1053 @@ + + + + TezosAppErrorCodes Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosAppErrorCodes

+
+
+ +
public enum TezosAppErrorCodes : String, Error, Codable
+ +
+
+

Dedicated error codes pulled from the Ledger tezos app

+ +
+
+
+
    +
  • +
    + + + + EXC_WRONG_PARAM + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_WRONG_PARAM = "6B00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_WRONG_LENGTH + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_WRONG_LENGTH = "6C00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_INVALID_INS + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_INVALID_INS = "6D00"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_WRONG_LENGTH_FOR_INS = "917E"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_REJECT + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_REJECT = "6985"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_PARSE_ERROR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_PARSE_ERROR = "9405"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_REFERENCED_DATA_NOT_FOUND = "6A88"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_WRONG_VALUES + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_WRONG_VALUES = "6A80"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_SECURITY + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_SECURITY = "6982"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_HID_REQUIRED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_HID_REQUIRED = "6983"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_CLASS + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_CLASS = "6E00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_MEMORY_ERROR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_MEMORY_ERROR = "9200"
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/LedgerWallet.html b/Classes/LedgerWallet.html new file mode 100644 index 00000000..df9ebdd7 --- /dev/null +++ b/Classes/LedgerWallet.html @@ -0,0 +1,1085 @@ + + + + LedgerWallet Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LedgerWallet

+
+
+ +
public class LedgerWallet : Wallet
+ +
+
+

A Tezos wallet class, used to cache infomration regarding the paired ledger device used to sign the payload. +This class can only be created by fetching data from a Ledger device and supplying this data to the constructor.

+ +

It is not possible to call the async sign function of this class, it will return null. Signing with a ledger is a complicated async process. +Please use the LedgerService class to setup a bluetooth connection, connect to the device and request a payload signing.

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The wallet type, hardcoded to always be WalletType.ledger

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var type: WalletType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The TZ address pulled from the Ledger device, cached to avoid complex retrieval when fetching balances etc.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    +

    The raw hex public key extracted from the Ledger, needed in order to perform REVEAL operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var publicKey: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + derivationPath + +
    +
    +
    +
    +
    +
    +

    The derivation path used to fetch the address and public key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var derivationPath: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + curve + +
    +
    +
    +
    +
    +
    +

    The elliptical curve used to fetch the address and public key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var curve: EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ledgerUUID + +
    +
    +
    +
    +
    +
    +

    The unique ledger UUID, that corresponds to this wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var ledgerUUID: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an instance of a LedgerWallet. Can return nil if invalid public key supplied

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(address: String, publicKey: String, derivationPath: String, curve: EllipticalCurve, ledgerUUID: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + address + + +
    +

    The TZ address pulled from the Ledger device

    +
    +
    + + publicKey + + +
    +

    The hex string denoting the public key, pulled from the ledger device

    +
    +
    + + derivationPath + + +
    +

    The derivation path used to fetch the address / publicKey

    +
    +
    + + curve + + +
    +

    The elliptical curve used to fetch the address / public key

    +
    +
    + + ledgerUUID + + +
    +

    The unique Ledger UUID to identify the Ledger

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Sign a hex string. +If the string starts with “03” and is not 32 characters long, it will be treated as a watermarked operation and Ledger will be asked to parse + display the operation details. +Else it will be treated as an unknown operation and will simply display the Blake2b hash. +Please be careful when asking the Ledger to parse (passing in an operation), Ledgers have very limited display ability. Keep it to a single operation, not invoking a smart contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKeyCurve() + +
    +
    +
    +
    +
    +
    +

    Function to extract the curve used to create the public key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func privateKeyCurve() -> EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Function to convert the public key into a Base58 encoded string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func publicKeyBase58encoded() -> String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/MediaProxyService.html b/Classes/MediaProxyService.html new file mode 100644 index 00000000..bb88166c --- /dev/null +++ b/Classes/MediaProxyService.html @@ -0,0 +1,1750 @@ + + + + MediaProxyService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediaProxyService

+
+
+ +
public class MediaProxyService : NSObject
+
extension MediaProxyService: URLSessionDownloadDelegate
+ +
+
+

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

+ +
+
+
+
    +
  • +
    + + + + Format + +
    +
    +
    +
    +
    +
    +

    Enum denoting the avaialble sizes for media

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum Format : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Source + +
    +
    +
    +
    +
    +
    +

    Supported source types for proxied media

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum Source : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + MediaType + +
    +
    +
    +
    +
    +
    +

    Supported media types

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum MediaType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + AggregatedMediaType + +
    +
    +
    +
    +
    +
    +

    Helper to parse a collection of media types to understand its contents

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum AggregatedMediaType : String, Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

URL conversion +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Take a URI from a token metadata response and convert it to a useable media proxy URL

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func url(fromUriString uri: String?, ofFormat format: Format, keepGif: Bool = false) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + fromUriString + + +
    +

    String containing a URI (supports IPFS URIs)

    +
    +
    + + ofFormat + + +
    +

    The requested format from the proxy

    +
    +
    +
    +
    +

    Return Value

    +

    An optional URL

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Take a URI from a token metadata response and convert it to a useable media proxy URL

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func url(fromUri uri: URL?, ofFormat format: Format, keepGif: Bool = false) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + fromUri + + +
    +

    URL object containing a URI (supports IPFS URIs)

    +
    +
    + + ofFormat + + +
    +

    The requested format from the proxy

    +
    +
    +
    +
    +

    Return Value

    +

    An optional URL

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper method to return a standard thumbnail URL for a NFT, taking into account some custom logic / known workarounds

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func thumbnailURL(forNFT nft: NFT, keepGif: Bool = false) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNFT + + +
    +

    NFT object

    +
    +
    +
    +
    +

    Return Value

    +

    An optional URL

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper method to return a standard larger display URL for a NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func displayURL(forNFT nft: NFT, keepGif: Bool = false) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNFT + + +
    +

    NFT object

    +
    +
    +
    +
    +

    Return Value

    +

    An optional URL

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Type checking +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Using only info from TzKTBalanceMetadataFormat determine the media type(s) of the object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getMediaType(fromFormats formats: [TzKTBalanceMetadataFormat]) -> [MediaType]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Given multiple sources of information, attempt to find the media type the url is pointing too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getMediaType(fromFormats formats: [TzKTBalanceMetadataFormat], orURL url: URL?, urlSession: URLSession = .shared, completion: @escaping ((Result<[MediaType], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + fromFormats + + +
    +

    An array of TzKTBalanceMetadataFormat that comes down with the TzKTClient’s balancing fetching code. It MAY contain infomration on the media type

    +
    +
    + + orURL + + +
    +

    The URL for the record. It MAY contain a file extension dennoting the file type

    +
    +
    + + urlSession + + +
    +

    If type can’t be found via URL or metadata, download the first packet, examine the headers for Content-Type using this session. (HEAD requests aren’t currently supported if the asset hasn’t been already cached)

    +
    +
    + + completion + + +
    +

    A block to run when a type can be found, or an error encountered

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + typesContents(_:) + +
    +
    +
    +
    +
    +
    +

    Helper method to parse an array of MediaType to quickly determine its content type so UI can be easily arraged

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func typesContents(_ types: [MediaType]) -> AggregatedMediaType?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Cache management +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Clear all images from all caches

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func removeAllImages(completion: @escaping (() -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func removeAllImages(fromCache: CacheType, completion: @escaping (() -> Void))
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + clearExpiredImages() + +
    +
    +
    +
    +
    +
    +

    Clear only iamges from cahce that have expired

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func clearExpiredImages()
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + sizeOf(cache:) + +
    +
    +
    +
    +
    +
    +

    Get size in bytes

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sizeOf(cache: CacheType) -> UInt
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Image loading +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Attempt to use KingFisher library to load an image from a URL, into an UIImageView, with support for downsampling, displaying loading spinner, svgs, gifs and the permanent / temporary caching system

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func load(url: URL?, to imageView: UIImageView, withCacheType cacheType: CacheType, fallback: UIImage, downSampleSize: CGSize? = nil, completion: ((CGSize?) -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + url + + +
    +

    Media proxy URL pointing to an image

    +
    +
    + + to + + +
    +

    The UIImageView to load the image into

    +
    +
    + + fromCache + + +
    +

    Which cahce to search for the image, or load it into if not found and needs to be downloaded

    +
    +
    + + fallback + + +
    +

    If an error occurs and an image can’t be downloaded/loaded in, display this image instead

    +
    +
    + + downSampleSize + + +
    +

    Supply the dimensions you wish the image to be resized to fit

    +
    +
    + + completion + + +
    +

    returns when operation finished, if successful it will return the downloaded image’s CGSize

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + imageCache(forType:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func imageCache(forType: CacheType) -> ImageCache
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Attempt to use KingFisher library to load an image from a URL, and store it directly in the cache for later usage. Also optional return the downloaded size via a completion block, useful for preparing table/collection view

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func cacheImage(url: URL?, cacheType: CacheType = .temporary, completion: @escaping ((CGSize?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + url + + +
    +

    Media proxy URL pointing to an image

    +
    +
    + + fromCache + + +
    +

    Which cahce to search for the image, or load it into if not found and needs to be downloaded

    +
    +
    + + completion + + +
    +

    returns when operation finished, if successful it will return the downloaded image’s CGSize

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Check if a given url is already cached

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func isCached(url: URL?, cacheType: CacheType = .temporary) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Check if an image is cached, and return its size if so. Useful for preparing table/collection view

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sizeForImageIfCached(url: URL?, cacheType: CacheType = .temporary, completion: @escaping ((CGSize?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + url + + +
    +

    Media proxy URL pointing to an image

    +
    +
    + + fromCache + + +
    +

    Which cahce to search for the image, or load it into if not found and needs to be downloaded

    +
    +
    + + completion + + +
    +

    returns when operation finished, if successful it will return the downloaded image’s CGSize

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didWriteData bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/MediaProxyService/AggregatedMediaType.html b/Classes/MediaProxyService/AggregatedMediaType.html new file mode 100644 index 00000000..6583b665 --- /dev/null +++ b/Classes/MediaProxyService/AggregatedMediaType.html @@ -0,0 +1,871 @@ + + + + AggregatedMediaType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

AggregatedMediaType

+
+
+ +
public enum AggregatedMediaType : String, Codable
+ +
+
+

Helper to parse a collection of media types to understand its contents

+ +
+
+
+
    +
  • +
    + + + + imageOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case imageOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + audioOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case audioOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + videoOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case videoOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + gifOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case gifOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + imageAndAudio + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case imageAndAudio
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/MediaProxyService/Format.html b/Classes/MediaProxyService/Format.html new file mode 100644 index 00000000..f8c7c916 --- /dev/null +++ b/Classes/MediaProxyService/Format.html @@ -0,0 +1,871 @@ + + + + Format Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Format

+
+
+ +
public enum Format : String, Codable
+ +
+
+

Enum denoting the avaialble sizes for media

+ +
+
+
+
    +
  • +
    + + + + icon + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case icon
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + small + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case small
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + medium + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case medium
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + gallery + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case gallery
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + raw + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case raw
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/MediaProxyService/MediaType.html b/Classes/MediaProxyService/MediaType.html new file mode 100644 index 00000000..13f75bef --- /dev/null +++ b/Classes/MediaProxyService/MediaType.html @@ -0,0 +1,845 @@ + + + + MediaType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediaType

+
+
+ +
public enum MediaType : String, Codable
+ +
+
+

Supported media types

+ +
+
+
+
    +
  • +
    + + + + image + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case image
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + audio + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case audio
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + video + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case video
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + gif + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case gif
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/MediaProxyService/Source.html b/Classes/MediaProxyService/Source.html new file mode 100644 index 00000000..2505845e --- /dev/null +++ b/Classes/MediaProxyService/Source.html @@ -0,0 +1,793 @@ + + + + Source Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Source

+
+
+ +
public enum Source : String, Codable
+ +
+
+

Supported source types for proxied media

+ +
+
+
+
    +
  • +
    + + + + ipfs + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ipfs
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + web + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case web
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/NetworkService.html b/Classes/NetworkService.html new file mode 100644 index 00000000..afe2e54a --- /dev/null +++ b/Classes/NetworkService.html @@ -0,0 +1,1267 @@ + + + + NetworkService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkService

+
+
+ +
public class NetworkService
+ +
+
+

Class responsible for sending all the networking requests, checking for http errors, RPC errors, Decoding the responses and optionally logging progress

+ +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + NetworkError + +
    +
    +
    +
    +
    +
    +

    Errors that can be returned by the NetworkService

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum NetworkError : Error
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + urlSession + +
    +
    +
    +
    +
    +
    +

    The URLSession used to preform all the networking operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let urlSession: URLSession
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + loggingConfig + +
    +
    +
    +
    +
    +
    +

    The URLSession used to preform all the networking operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let loggingConfig: LoggingConfig
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Init an NetworkService with a URLSession

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(urlSession: URLSession, loggingConfig: LoggingConfig)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + urlSession + + +
    +

    A URLSession object

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A generic send function that takes an RPC, with a generic type conforming to Decodable, executes the request and returns the result.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func send<T>(rpc: RPC<T>, withBaseURL baseURL: URL, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + rpc + + +
    +

    A instance of RPC.

    +
    +
    + + withBaseURL + + +
    +

    The base URL needed. This will typically come from TezosNodeConfig.

    +
    +
    + + completion + + +
    +

    A completion callback that will be executed on the main thread.

    +
    +
    +
    +
    +

    Return Value

    +

    Void

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response. +Using the Logging config, will auto log (or not) urls, response outputs, or fails to the console

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func request<T>(url: URL, isPOST: Bool, withBody body: Data?, forReturnType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + url + + +
    +

    The full url, including query parameters to execute.

    +
    +
    + + isPOST + + +
    +

    Bool indicating if its a POST or GET request.

    +
    +
    + + withBody + + +
    +

    Optional Data to be passed as the body.

    +
    +
    + + forReturnType + + +
    +

    The Type to parse the response as.

    +
    +
    + + completion + + +
    +

    A completion block with a Result<T, Error> T being the supplied decoable type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response, returning it as a combine publisher. +Using the Logging config, will auto log (or not) urls, response outputs, or fails to the console

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func request<T>(url: URL, isPOST: Bool, withBody body: Data?, forReturnType: T.Type) -> AnyPublisher<T, KukaiError> where T : Decodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + url + + +
    +

    The full url, including query parameters to execute.

    +
    +
    + + isPOST + + +
    +

    Bool indicating if its a POST or GET request.

    +
    +
    + + withBody + + +
    +

    Optional Data to be passed as the body.

    +
    +
    + + forReturnType + + +
    +

    The Type to parse the response as.

    +
    +
    +
    +
    +

    Return Value

    +

    A publisher of the supplied return type, or error response

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Logging +

+
+
+ +
+
+
+ +
+
+ + diff --git a/Classes/NetworkService/NetworkError.html b/Classes/NetworkService/NetworkError.html new file mode 100644 index 00000000..4aacc2a9 --- /dev/null +++ b/Classes/NetworkService/NetworkError.html @@ -0,0 +1,845 @@ + + + + NetworkError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkError

+
+
+ +
public enum NetworkError : Error
+ +
+
+

Errors that can be returned by the NetworkService

+ +
+
+
+
    +
  • +
    + + + + parse(error:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parse(error: String)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidURL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case httpError(statusCode: Int, response: String?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/ObjktClient.html b/Classes/ObjktClient.html new file mode 100644 index 00000000..628b51b8 --- /dev/null +++ b/Classes/ObjktClient.html @@ -0,0 +1,1042 @@ + + + + ObjktClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktClient

+
+
+ +
public class ObjktClient
+ +
+
+

Client for interacting with the API of the popular NFT marketplace, OBJKT.com +Client exposes functions for fetching metadata, pricing, purchase offers, listing etc

+ +
+
+
+
    +
  • +
    + + + + collections + +
    +
    +
    +
    +
    +
    +

    Cached metadata of NFT collections, e.g. name, thumbnailURL etc

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var collections: [String : ObjktCollection]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokens + +
    +
    +
    +
    +
    +
    +

    Cached metadata of specific tokens, e.g. prices, offers etc

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tokens: [String : ObjktTokenReponse]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Public single functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Take in an array of contract addresses, and return a list of the ones that we currently have no metadata for

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func unresolvedCollections(addresses: [String]) -> [String]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Search OBJKT to find metadata on the list of addresses provided

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func resolveCollectionsAll(addresses: [String], completion: @escaping ((Result<Bool, KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Find the metadata of a list of contracts, used recurrisvely to find all collections while limited to request query size

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func resolveCollectionsPage(addresses: ArraySlice<String>, completion: @escaping ((Result<GraphQLResponse<ObjktCollections>, KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Find the meatdata of a specific token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func resolveToken(address: String, tokenId: Decimal, forOwnerWalletAddress walletAddress: String, completion: @escaping ((Result<GraphQLResponse<ObjktTokenReponse>, KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper to fetch a specific token metadata from the cache

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenResponse(forAddress: String, tokenId: Int) -> ObjktTokenReponse?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + deleteCache() + +
    +
    +
    +
    +
    +
    +

    Clear all the cached data

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteCache()
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/Operation.html b/Classes/Operation.html new file mode 100644 index 00000000..f068a02f --- /dev/null +++ b/Classes/Operation.html @@ -0,0 +1,1049 @@ + + + + Operation Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Operation

+
+
+ +
public class Operation : Codable
+ +
+
+

Base class representing an Operation on the Tezos network. On its own this class can’t be sent to the network. See its subclasses for more info.

+ +
+
+
+
    +
  • +
    + + + + operationKind + +
    +
    +
    +
    +
    +
    +

    An enum to denote the type of operation. e.g. transaction, delegation, reveal etc.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operationKind: OperationKind
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + source + +
    +
    +
    +
    +
    +
    +

    The source address for the operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var source: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    +

    A string representing a numeric counter. Must be unique and 1 higher than the previous counter. Current counter obtained from the metadata query in TezosNodeClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var counter: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationFees + +
    +
    +
    +
    +
    +
    +

    Object representing the various fees, storage and compute required to fulfil this operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var operationFees: OperationFees
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(operationKind: OperationKind, source: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + operationKind + + +
    +

    The type of operation.

    +
    +
    + + source + + +
    +

    The address of the acocunt sending the operation.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: Operation) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationActivateAccount.html b/Classes/OperationActivateAccount.html new file mode 100644 index 00000000..53d08544 --- /dev/null +++ b/Classes/OperationActivateAccount.html @@ -0,0 +1,993 @@ + + + + OperationActivateAccount Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationActivateAccount

+
+
+ +
public class OperationActivateAccount : Operation
+ +
+
+

Operation subclass for revealing a publickey to the network.

+ +
+
+
+
    +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let publicKey: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + secret + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let secret: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationActivateAccount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, andSecret: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + wallet + + +
    +

    The Wallet object, whose publicKey will be used to activate on the network

    +
    +
    + + andSecret + + +
    +

    The secret supplied in JSON file

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationActivateAccount) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationBallot.html b/Classes/OperationBallot.html new file mode 100644 index 00000000..b4213373 --- /dev/null +++ b/Classes/OperationBallot.html @@ -0,0 +1,955 @@ + + + + OperationBallot Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationBallot

+
+
+ +
public class OperationBallot : Operation
+ +
+
+

Operation to submit a ballot on an upcoming proposal

+ +
+
+
+
    +
  • +
    + + + + Ballot + +
    +
    +
    +
    +
    +
    +

    Enum matching the available ballot options

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum Ballot : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + period + +
    +
    +
    +
    +
    +
    +

    The voting period

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let period: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proposal + +
    +
    +
    +
    +
    +
    +

    The identifier of the proposa;

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let proposal: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ballot + +
    +
    +
    +
    +
    +
    +

    The wallet holders vote

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let ballot: Ballot
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init with wallet, period, proposal and ballot

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, period: Int, proposal: String, ballot: Ballot)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationBallot) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationBallot/Ballot.html b/Classes/OperationBallot/Ballot.html new file mode 100644 index 00000000..6fe8a0be --- /dev/null +++ b/Classes/OperationBallot/Ballot.html @@ -0,0 +1,819 @@ + + + + Ballot Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Ballot

+
+
+ +
public enum Ballot : String, Codable
+ +
+
+

Enum matching the available ballot options

+ +
+
+
+
    +
  • +
    + + + + nay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case nay
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + yay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case yay
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + pass + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case pass
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationDelegation.html b/Classes/OperationDelegation.html new file mode 100644 index 00000000..b72471c6 --- /dev/null +++ b/Classes/OperationDelegation.html @@ -0,0 +1,968 @@ + + + + OperationDelegation Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationDelegation

+
+
+ +
public class OperationDelegation : Operation
+ +
+
+

Operation subclass for delegating an account to a baker

+ +
+
+
+
    +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    The baker to delegate too, or nil to undelegate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegate: String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationDelegation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(source: String, delegate: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + source + + +
    +

    The address of the acocunt sending the operation.

    +
    +
    + + delegate + + +
    +

    Optional. The address of the baker to delegate to, or nil to undelegate the source address.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationDelegation) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationDoubleBakingEvidence.html b/Classes/OperationDoubleBakingEvidence.html new file mode 100644 index 00000000..ad4b518f --- /dev/null +++ b/Classes/OperationDoubleBakingEvidence.html @@ -0,0 +1,900 @@ + + + + OperationDoubleBakingEvidence Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationDoubleBakingEvidence

+
+
+ +
public class OperationDoubleBakingEvidence : Operation
+ +
+
+

Operation to report a baking of baking the same block twice

+ +
+
+
+
    +
  • +
    + + + + bh1 + +
    +
    +
    +
    +
    +
    +

    The block header of the first baked block

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bh1: OperationBlockHeader
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bh2 + +
    +
    +
    +
    +
    +
    +

    The block header of the second baked block

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bh2: OperationBlockHeader
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(wallet:bh1:bh2:) + +
    +
    +
    +
    +
    +
    +

    Init with wallet and two block headers

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, bh1: OperationBlockHeader, bh2: OperationBlockHeader)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationDoubleBakingEvidence) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationDoubleEndorsementEvidence.html b/Classes/OperationDoubleEndorsementEvidence.html new file mode 100644 index 00000000..2751ba95 --- /dev/null +++ b/Classes/OperationDoubleEndorsementEvidence.html @@ -0,0 +1,928 @@ + + + + OperationDoubleEndorsementEvidence Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationDoubleEndorsementEvidence

+
+
+ +
public class OperationDoubleEndorsementEvidence : Operation
+ +
+
+

Operation to report a baker trying to endorse a block twice

+ +
+
+
+
    +
  • +
    + + + + InlinedEndorsement + +
    +
    +
    +
    +
    +
    +

    Internal struct used to amtch expected struct of data

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct InlinedEndorsement : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + op1 + +
    +
    +
    +
    +
    +
    +

    The first endorsement

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let op1: InlinedEndorsement
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + op2 + +
    +
    +
    +
    +
    +
    +

    The second endorsement (should be matching details of first)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let op2: InlinedEndorsement
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(wallet:op1:op2:) + +
    +
    +
    +
    +
    +
    +

    Init with wallet and 2 suspected endorsements

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, op1: InlinedEndorsement, op2: InlinedEndorsement)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationDoubleEndorsementEvidence) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html b/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html new file mode 100644 index 00000000..78c3b380 --- /dev/null +++ b/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html @@ -0,0 +1,846 @@ + + + + InlinedEndorsement Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

InlinedEndorsement

+
+
+ +
public struct InlinedEndorsement : Codable, Equatable
+ +
+
+

Internal struct used to amtch expected struct of data

+ +
+
+
+
    +
  • +
    + + + + branch + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let branch: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operations + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operations: Content
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + signature + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let signature: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Content + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Content : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html b/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html new file mode 100644 index 00000000..d9a7f2ca --- /dev/null +++ b/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html @@ -0,0 +1,792 @@ + + + + Content Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Content

+
+
+ +
public struct Content : Codable, Equatable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + kind + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let kind: OperationKind
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationEndorsement.html b/Classes/OperationEndorsement.html new file mode 100644 index 00000000..9e912315 --- /dev/null +++ b/Classes/OperationEndorsement.html @@ -0,0 +1,873 @@ + + + + OperationEndorsement Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationEndorsement

+
+
+ +
public class OperationEndorsement : Operation
+ +
+
+

Operation for endorsing a block

+ +
+
+
+
    +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    +

    Block level

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(wallet:level:) + +
    +
    +
    +
    +
    +
    +

    Init with wallet and block level

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, level: Int)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationEndorsement) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationFactory.html b/Classes/OperationFactory.html new file mode 100644 index 00000000..bc1e64f6 --- /dev/null +++ b/Classes/OperationFactory.html @@ -0,0 +1,2017 @@ + + + + OperationFactory Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationFactory

+
+
+ +
public class OperationFactory
+ +
+
+

Class responsible for creating operations necessary to perform a given action, and converting those operations into the single payload expected by the RPC. +Although not every action requires more than one operation, all functions will return an array, for consistency.

+ +
+
+
+
+ + +
+ +

Operation Builders +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to send an amount of a token to a destination address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sendOperation(_ tokenAmount: TokenAmount, of token: Token, from: String, to: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + _ + + +
    +

    The amount of the given token to send.

    +
    +
    + + of + + +
    +

    The Token type that will be sent.

    +
    +
    + + from + + +
    +

    The address to deduct the funds from.

    +
    +
    + + to + + +
    +

    The destination address that will recieve the funds.

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to send aan NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sendOperation(_ amount: Decimal, ofNft nft: NFT, from: String, to: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + ofNft + + +
    +

    The NFT type that will be sent.

    +
    +
    + + from + + +
    +

    The address to deduct the funds from.

    +
    +
    + + to + + +
    +

    The destination address that will recieve the funds.

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to delegate funds to a baker.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func delegateOperation(to: String, from: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + to + + +
    +

    The address of the baker to delegate to.

    +
    +
    + + from + + +
    +

    The address that wishes to delegate its funds.

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to remove the current delegate from an address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func undelegateOperation(address: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + address + + +
    +

    The address that wishes to remove its delegate.

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to perform an exchange of XTZ for a given FA token, using a given dex

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func swapXtzToToken(withDex dex: DipDupExchange, xtzAmount: XTZAmount, minTokenAmount: TokenAmount, walletAddress: String, timeout: TimeInterval) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + withDex + + +
    +

    Enum controling which dex to use to perform the swap

    +
    +
    + + xtzAmount + + +
    +

    The amount of XTZ to be swaped

    +
    +
    + + minTokenAmount + + +
    +

    The minimum token amount you will accept

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    + + timeout + + +
    +

    Max amount of time to wait before asking the node to cancel the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to perform an exchange of a given FA token for XTZ, using dex contracts

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func swapTokenToXTZ(withDex dex: DipDupExchange, tokenAmount: TokenAmount, minXTZAmount: XTZAmount, walletAddress: String, timeout: TimeInterval) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + withDex + + +
    +

    DipDupExchange instance providing information about the exchange

    +
    +
    + + tokenAmount + + +
    +

    The amount of Token to be swapped

    +
    +
    + + minXTZAmount + + +
    +

    The minimum xtz amount you will accept

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    + + timeout + + +
    +

    Max amount of time to wait before asking the node to cancel the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Allowance (approve, update_operators) +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create an operation to call the entrypoint approve, to allow another address to spend some of your token (only FA1.2) +Used when interacting with smart contract applications like Dexter or QuipuSwap

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func approveOperation(tokenAddress: String, spenderAddress: String, allowance: TokenAmount, walletAddress: String) -> Operation
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + tokenAddress + + +
    +

    The address of the token contract

    +
    +
    + + spenderAddress + + +
    +

    The address that is being given permission to spend the users balance

    +
    +
    + + allowance + + +
    +

    The allowance to set for the given contract

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An OperationTransaction which will invoke a smart contract call

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an operation to call the entrypoint update_operators, to allow another address to spend some of your token (only FA2) +Used when interacting with smart contract applications like Dexter or QuipuSwap

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func updateOperatorsOperation(tokenAddress: String, spenderAddress: String, allowance: TokenAmount, walletAddress: String) -> Operation
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + tokenAddress + + +
    +

    The address of the token contract

    +
    +
    + + spenderAddress + + +
    +

    The address that is being given permission to spend the users balance

    +
    +
    + + allowance + + +
    +

    The allowance to set for the given contract

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An OperationTransaction which will invoke a smart contract call

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return the operation necessary to register an allowance (either calling apporve or update_operators) depending on the token standard version. Removing the need to check manually +Used when interacting with smart contract applications like Dexter or QuipuSwap

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func allowanceOperation(standard: DipDupTokenStandard, tokenAddress: String, spenderAddress: String, allowance: TokenAmount, walletAddress: String) -> Operation
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + standard + + +
    +

    The FA standard that the token conforms too

    +
    +
    + + tokenAddress + + +
    +

    The address of the token contract

    +
    +
    + + spenderAddress + + +
    +

    The address that is being given permission to spend the users balance

    +
    +
    + + allowance + + +
    +

    The allowance to set for the given contract

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An OperationTransaction which will invoke a smart contract call

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Dex functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to add liquidity to a dex contract. Use DexCalculationService to figure out the numbers required

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func addLiquidity(withDex dex: DipDupExchange, xtz: XTZAmount, token: TokenAmount, minLiquidty: TokenAmount, isInitialLiquidity: Bool, walletAddress: String, timeout: TimeInterval) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + withDex + + +
    +

    DipDupExchange instance providing information about the exchange

    +
    +
    + + xtz + + +
    +

    The amount of XTZ to deposit

    +
    +
    + + token + + +
    +

    The amount of Token to deposit

    +
    +
    + + minLiquidty + + +
    +

    The minimum amount of liquidity tokens you will accept

    +
    +
    + + isInitialLiquidity + + +
    +

    Is this the xtzPool and tokenPool empty? If so, the operation needs to set the exchange rate for the dex. Some dex’s require extra logic here

    +
    +
    + + wallet + + +
    +

    The wallet that will sign the operation

    +
    +
    + + timeout + + +
    +

    The timeout in seconds, before the dex contract should cancel the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to remove liquidity from a dex contract, also withdraw pending rewards if applicable. Use DexCalculationService to figure out the numbers required

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func removeLiquidity(withDex dex: DipDupExchange, minXTZ: XTZAmount, minToken: TokenAmount, liquidityToBurn: TokenAmount, walletAddress: String, timeout: TimeInterval) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + withDex + + +
    +

    DipDupExchange instance providing information about the exchange

    +
    +
    + + minXTZ + + +
    +

    The minimum XTZ to accept in return for the burned amount of Liquidity

    +
    +
    + + minToken + + +
    +

    The minimum Token to accept in return for the burned amount of Liquidity

    +
    +
    + + liquidityToBurn + + +
    +

    The amount of Liqudity to burn

    +
    +
    + + wallet + + +
    +

    The wallet that will sign the operation

    +
    +
    + + timeout + + +
    +

    The timeout in seconds, before the dex contract should cancel the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to withdraw rewards from a dex contract. For example in quipuswap, XTZ provided as liquidity will earn baking rewards. This can been withdrawn at any time while leaving liquidity in palce

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func withdrawRewards(withDex dex: DipDupExchange, walletAddress: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + withDex + + +
    +

    DipDupExchange instance providing information about the exchange

    +
    +
    + + wallet + + +
    +

    The wallet that will sign the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Utilities +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Convert an array of operations into the format expected by the RPC. Will also inject a OperationReveal if the sender has not yet revealed their public key.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func operationPayload(fromMetadata metadata: OperationMetadata, andOperations operations: [Operation], walletAddress: String, base58EncodedPublicKey: String) -> OperationPayload
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + fromMetadata + + +
    +

    OperationMeatdata containing necessary data to form the object.

    +
    +
    + + andOperations + + +
    +

    An array of Operation subclasses to send.

    +
    +
    + + withWallet + + +
    +

    The Wallet instance that will be responsible for these operations.

    +
    +
    +
    +
    +

    Return Value

    +

    An instance of OperationPayload that can be sent to the RPC

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Dexter requires date strings to act as deadline dates for exchanges. +This function takes a TimeInterval and uses it to createa date in the future, and returns that as a formatted string.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func createDexterTimestampString(nowPlusTimeInterval: TimeInterval) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + nowPlusTimeInterval + + +
    +

    The amount of time in the future the date string should represent.

    +
    +
    +
    +
    +

    Return Value

    +

    A formatted date String

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sendTokenMichelson(forFaVersion faVersion: FaVersion, tokenAmount: TokenAmount, tokenId: Decimal, to: String, from: String) -> [String : Any]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Extractors +

+
+
+
    +
  • +
    + + + + Extractor + +
    +
    +
    +
    +
    +
    +

    Internal Struct to encapsulate helpers methods needed to extract critical information from an array of operations, needed for processing decisions like “do i display a send token screen, or a send NFt screen”, fetching total XTZ sent in 1 action etc

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Extractor
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationFactory/Extractor.html b/Classes/OperationFactory/Extractor.html new file mode 100644 index 00000000..a5b5f6b2 --- /dev/null +++ b/Classes/OperationFactory/Extractor.html @@ -0,0 +1,961 @@ + + + + Extractor Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Extractor

+
+
+ +
public struct Extractor
+ +
+
+

Internal Struct to encapsulate helpers methods needed to extract critical information from an array of operations, needed for processing decisions like “do i display a send token screen, or a send NFt screen”, fetching total XTZ sent in 1 action etc

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Extract rpc amount (without decimal info) a tokenId, and the destination from a michelson FA1.2 / FA2 transfer payload

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func tokenIdAndAmountFromSendMichelson(michelson: Any) -> (rpcAmount: String, tokenId: Decimal?, destination: String)?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Extract details from a payload in order to present to the user what it is they are trying to send

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func faTokenDetailsFrom(transaction: OperationTransaction) -> (tokenContract: String, rpcAmount: String, tokenId: Decimal?, destination: String)?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper to call faTokenDetailsFrom(transaction: OperationTransaction) on the first OperationTransaction in an array of operations. Allows to more easily parse an array of operations that may include approval‘s or update_operator calls

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func faTokenDetailsFrom(operations: [Operation]) -> (tokenContract: String, rpcAmount: String, tokenId: Decimal?, destination: String)?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return true if

    + +
      +
    • contains 1 operation with a non-zero amount, with no parameters
    • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func isTezTransfer(operations: [Operation]) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Easy way to extract the first non-approval or update_operator transaction

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func firstTransferEntrypointOperation(operations: [Operation]) -> OperationTransaction?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return the entrypoint and address of the first operation, that doesn’t equal approve, update_operator or transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func isContractCall(operations: [Operation]) -> (entrypoint: String, address: String)?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return the first operation where entrypoint doesn’t equal approve, update_operator or transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func firstContractCallOperation(operations: [Operation]) -> OperationTransaction?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Run through list of operations and extract .amount from any OperationTransaction

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func totalXTZAmountForContractCall(operations: [Operation]) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationOrigination.html b/Classes/OperationOrigination.html new file mode 100644 index 00000000..0313083a --- /dev/null +++ b/Classes/OperationOrigination.html @@ -0,0 +1,1019 @@ + + + + OperationOrigination Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationOrigination

+
+
+ +
public class OperationOrigination : Operation
+ +
+
+

Operation subclass for originating a contract on the Tezos network

+ +
+
+
+
    +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    The initial balance to give to the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + script + +
    +
    +
    +
    +
    +
    +

    Dictionary holding the code and storage of the contract to create.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let script: [String : String]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationOrigination.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(source: String, balance: XTZAmount, code: String, storage: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + source + + +
    +

    The address originating the contract and paying the fees.

    +
    +
    + + balance + + +
    +

    How much XTZ to initiate the contract with.

    +
    +
    + + code + + +
    +

    Micheline string containing the contract code.

    +
    +
    + + storage + + +
    +

    Micheline string containing the initial storage of the contract.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationOrigination) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationProposals.html b/Classes/OperationProposals.html new file mode 100644 index 00000000..1d5b03ea --- /dev/null +++ b/Classes/OperationProposals.html @@ -0,0 +1,899 @@ + + + + OperationProposals Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationProposals

+
+
+ +
public class OperationProposals : Operation
+ +
+
+ +
+
+
+
    +
  • +
    + + + + period + +
    +
    +
    +
    +
    +
    +

    The voting period

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let period: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proposals + +
    +
    +
    +
    +
    +
    +

    List of proposal identifiers

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let proposals: [String]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init with wallet, voting period and list of proposal identifiers

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, period: Int, proposals: [String])
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationProposals) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationReveal.html b/Classes/OperationReveal.html new file mode 100644 index 00000000..c2c046c0 --- /dev/null +++ b/Classes/OperationReveal.html @@ -0,0 +1,1013 @@ + + + + OperationReveal Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationReveal

+
+
+ +
public class OperationReveal : Operation
+ +
+
+

Operation subclass for revealing a publickey to the network.

+ +
+
+
+
    +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let publicKey: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(wallet:) + +
    +
    +
    +
    +
    +
    +

    Create an OperationReveal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + wallet + + +
    +

    The Wallet object, whose publicKey needs to be revealed.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationReveal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(base58EncodedPublicKey: String, walletAddress: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + base58EncodedPublicKey + + +
    +

    The Wallet object, whose publicKey needs to be revealed.

    +
    +
    + + walletAddress + + +
    +

    The Wallet object, whose publicKey needs to be revealed.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationReveal) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationSeedNonceRevelation.html b/Classes/OperationSeedNonceRevelation.html new file mode 100644 index 00000000..e1f54071 --- /dev/null +++ b/Classes/OperationSeedNonceRevelation.html @@ -0,0 +1,899 @@ + + + + OperationSeedNonceRevelation Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationSeedNonceRevelation

+
+
+ +
public class OperationSeedNonceRevelation : Operation
+ +
+
+

Operation to reveal seed nonce to blockchain

+ +
+
+
+
    +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    +

    Block level

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nonce + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let nonce: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init with wallet object, block level, and nonce

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, level: Int, nonce: String)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationSeedNonceRevelation) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationService.html b/Classes/OperationService.html new file mode 100644 index 00000000..db2c5e82 --- /dev/null +++ b/Classes/OperationService.html @@ -0,0 +1,1530 @@ + + + + OperationService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationService

+
+
+ +
public class OperationService
+ +
+
+

Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

+ +
+
+
+
    +
  • +
    + + + + OperationServiceError + +
    +
    +
    +
    +
    +
    +

    Errors that the OperationService is capable of returning

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum OperationServiceError : Error
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Used to return a bunch of formatted data, to make interacting with ledger sign operation easier

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct LedgerPayloadPrepResponse
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + config + +
    +
    +
    +
    +
    +
    +

    The configuration object containing all the necessary settings to connect and communicate with the Tezos node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let config: TezosNodeClientConfig
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkService + +
    +
    +
    +
    +
    +
    +

    The NetworkService object that will perform all the networking calls

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let networkService: NetworkService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Top level functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    When using remote forging, every Operation needs to be Forged, Parsed, Signed, Preapply’d and Injected to make its way into the blockchain. +This function will complete all of those steps and return an OperationID or an Error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func remoteForgeParseSignPreapplyInject(operationMetadata: OperationMetadata, operationPayload: OperationPayload, wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + operationMetadata + + +
    +

    The latest OperationMetadata from the TezosNodeClient

    +
    +
    + + operationPayload + + +
    +

    The OperationPayload generated by the OperationFactory

    +
    +
    + + wallet + + +
    +

    The Wallet that will sign the operation

    +
    +
    + + completion + + +
    +

    Completion block either returning a String containing an OperationHash of the injected Operation, or an Error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    When using local forging, every Operation needs to be Forged, Signed, Preapply’d and Injected to make its way into the blockchain. +This function will complete all of those steps and return an OperationID or an Error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func localForgeSignPreapplyInject(operationMetadata: OperationMetadata, operationPayload: OperationPayload, wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + operationMetadata + + +
    +

    The latest OperationMetadata from the TezosNodeClient

    +
    +
    + + operationPayload + + +
    +

    The OperationPayload generated by the OperationFactory

    +
    +
    + + wallet + + +
    +

    The Wallet that will sign the operation

    +
    +
    + + completion + + +
    +

    Completion block either returning a String containing an OperationHash of the injected Operation, or an Error

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Helpers / wrappers +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Ledger can only parse operations under certain conditions. These conditions are not documented well. This function will attempt to determine whether the payload can be parsed or not, and returnt he appropriate string for the LedgerWallet sign function +It seems to be able to parse the payload if it contains 1 operation, of the below types. Combining types (like Reveal + Transation) causes a parse error +If the payload structure passes the conditions we are aware of, allow parsing to take place. If not, sign blake2b hash instead

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func ledgerStringToSign(forgedHash: String, operationPayload: OperationPayload) -> String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Preapply and Inject wrapped up as one function, for situations like Ledger Wallets, where signing is a complately different process, and must be done elsewhere

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func preapplyAndInject(forgedOperation: String, signature: [UInt8], signatureCurve: EllipticalCurve, operationPayload: OperationPayload, operationMetadata: OperationMetadata, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + forgedOperation + + +
    +

    The forged operation hex without a watermark.

    +
    +
    + + signature + + +
    +

    Binary representation of the signed operation forge.

    +
    +
    + + signatureCurve + + +
    +

    The curve used to sign the forge.

    +
    +
    + + operationPayload + + +
    +

    The payload to be sent.

    +
    +
    + + operationMetadata + + +
    +

    The metadata required to send the payload.

    +
    +
    + + completion + + +
    +

    callback with a forged hash or an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Forge an OperationPayload remotely, so it can be sent to the RPC.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func remoteForge(operationPayload: OperationPayload, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + operationPayload + + +
    +

    created from OperationFactory.operationPayload().

    +
    +
    + + wallet + + +
    +

    The Wallet object that will sign the operations.

    +
    +
    + + completion + + +
    +

    callback with a forged hash or an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Parse a forged OperationPayload on a different server to ensure nobody maliciously tampared with the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func remoteParse(forgeResult: Result<String, KukaiError>, operationMetadata: OperationMetadata, operationPayload: OperationPayload, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + forgeResult + + +
    +

    The Result object from the forge(...) function.

    +
    +
    + + operationMetadata + + +
    +

    fetched from getOperationMetadata(...).

    +
    +
    + + operationPayload + + +
    +

    the OperationPayload to compare against to ensure it matches.

    +
    +
    + + completion + + +
    +

    callback which just returns success or failure with an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Preapply a signed OperationPayload to check for any errors.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func preapply(operationPayload: OperationPayload, completion: @escaping ((Result<[OperationResponse], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + operationMetadata + + +
    +

    Fetched from getOperationMetadata(...).

    +
    +
    + + operationPayload + + +
    +

    An OperationPayloadthat has had a signature and a protcol added to it.

    +
    +
    + + completion + + +
    +

    Callback which just returns success or failure with an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Inject a signed bytes to become part of the next block on the blockchain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func inject(signedBytes: String, handlePreapplyResult: Result<[OperationResponse], KukaiError>?, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + signedBytes + + +
    +

    The result of the forge operation (as a string) with the signature (as a hex string) appended on.

    +
    +
    + + handlePreapplyResult + + +
    +

    Optionally pass in the result of the preapply function to reduce the indentation required to perform the full set of operations. Any error will be returned via the injection Result object.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationService/LedgerPayloadPrepResponse.html b/Classes/OperationService/LedgerPayloadPrepResponse.html new file mode 100644 index 00000000..ffc09580 --- /dev/null +++ b/Classes/OperationService/LedgerPayloadPrepResponse.html @@ -0,0 +1,897 @@ + + + + LedgerPayloadPrepResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LedgerPayloadPrepResponse

+
+
+ +
public struct LedgerPayloadPrepResponse
+ +
+
+

Used to return a bunch of formatted data, to make interacting with ledger sign operation easier

+ +
+
+
+
    +
  • +
    + + + + payload + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payload: OperationPayload
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + forgedOp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let forgedOp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + watermarkedOp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let watermarkedOp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + blake2bHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let blake2bHash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let metadata: OperationMetadata
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + canLedgerParse + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let canLedgerParse: Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationService/OperationServiceError.html b/Classes/OperationService/OperationServiceError.html new file mode 100644 index 00000000..ba97aec0 --- /dev/null +++ b/Classes/OperationService/OperationServiceError.html @@ -0,0 +1,949 @@ + + + + OperationServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationServiceError

+
+
+ +
public enum OperationServiceError : Error
+ +
+
+

Errors that the OperationService is capable of returning

+ +
+
+
+
    +
  • +
    + + + + unableToSetupForge + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToSetupForge
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unableToSetupParse + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToSetupParse
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseFailed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parseFailed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + signingFailure + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case signingFailure
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unableToSetupPreapply + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToSetupPreapply
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case preapplyContainedError(errors: [OperationResponseInternalResultError]?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unableToSetupInject + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToSetupInject
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + noRemoteParseURLFound + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noRemoteParseURLFound
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/OperationTransaction.html b/Classes/OperationTransaction.html new file mode 100644 index 00000000..fd0c6f58 --- /dev/null +++ b/Classes/OperationTransaction.html @@ -0,0 +1,1110 @@ + + + + OperationTransaction Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationTransaction

+
+
+ +
public class OperationTransaction : Operation
+ +
+
+

Operation subclass for sending XTZ to a destination

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var amount: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + destination + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let destination: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parameters + +
    +
    +
    +
    +
    +
    +

    Dictionary holding the entrypoint and value of the contract call

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parameters: [String : Any]?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Constructors +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create an OperationTransaction, to send an amount of token to a destination

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(amount: TokenAmount, source: String, destination: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value.

    +
    +
    + + source + + +
    +

    The address of the acocunt sending the operation.

    +
    +
    + + destination + + +
    +

    The destination address to recieve the funds.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationTransaction, to invoke a smart contract call

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(amount: TokenAmount, source: String, destination: String, parameters: [String : Any])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value.

    +
    +
    + + source + + +
    +

    The address of the acocunt sending the operation.

    +
    +
    + + parameters + + +
    +

    A dictionary containing the michlelson JSON representation needed to invoke a smart contract. Should contain a key entrypoint with a string and value which can either be a dictionary of anything, or an array of dicitonaries of anything

    +
    +
    + + destination + + +
    +

    The destination address to recieve the funds.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable +

+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationTransaction) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/RPC.html b/Classes/RPC.html new file mode 100644 index 00000000..48d112ca --- /dev/null +++ b/Classes/RPC.html @@ -0,0 +1,1478 @@ + + + + RPC Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

RPC

+
+
+ +
public class RPC<T> where T : Decodable
+ +
+
+

A generic class representing an RPC call to the Tezos network. +A type must be passed in when creating an instance of this object, this will be used by the network layer to parse the response and detect errors.

+ +
+
+
+
+ + +
+ +

Public properties +

+
+
+
    +
  • +
    + + + + endpoint + +
    +
    +
    +
    +
    +
    +

    The endpoint that will be added onto the TezosNodeConfig.primaryNodeURL to form a full URL for the request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let endpoint: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payload + +
    +
    +
    +
    +
    +
    +

    An optional payload for sending HTTP POST requests

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payload: Data?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + responseType + +
    +
    +
    +
    +
    +
    +

    The expected response type from the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let responseType: T.Type
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isPost + +
    +
    +
    +
    +
    +
    +

    Computed property to indicate wheter or not this is a POST request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isPost: Bool { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Init an RPC object, to be passed to the network layer to performa request to the node.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(endpoint: String, payload: Data?, responseType: T.Type)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + endpoint + + +
    +

    The endpoint to send the request too.

    +
    +
    + + payload + + +
    +

    An optional payload for POST requests.

    +
    +
    + + responseType + + +
    +

    The expected response type from the network.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper function to wrap up JSONEncoder().encode and log any errors.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func encodableToData<T>(encodable: T) -> Data? where T : Encodable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == String +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch an XTZ balance for a given Address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func xtzBalance(forAddress address: String) -> RPC<String>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch a deelgate for a given Address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getDelegate(forAddress address: String) -> RPC<String>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the managerKey for a given Address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func managerKey(forAddress address: String) -> RPC<String?>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter(forAddress:) + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the current counter for a given Address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func counter(forAddress address: String) -> RPC<String>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to remotely forge an operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func forge(operationPayload: OperationPayload) -> RPC<String>?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + inject(signedBytes:) + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to inject an operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func inject(signedBytes: String) -> RPC<String>?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == BlockchainHead +

+
+
+
    +
  • +
    + + + + blockchainHead() + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the HEAD of the blockchain and parse it into an object to extract the pieces we are interested in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func blockchainHead() -> RPC<BlockchainHead>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the HEAD of 3 blocks previous and parse it into an object to extract the pieces we are interested in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func blockchainHeadMinus3() -> RPC<BlockchainHead>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == NetworkVersion +

+
+
+
    +
  • +
    + + + + networkVersion() + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the details about the version of the network running on the given server.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func networkVersion() -> RPC<NetworkVersion>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == NetworkConstants +

+
+
+
    +
  • +
    + + + + networkConstants() + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the network constants for the given server, such as how much mutez it costs per byte of storage, or the maximum allowed gas amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func networkConstants() -> RPC<NetworkConstants>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == [OperationPayload] +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to remotely parse an operation to verify its contents. Function takes in a hash, as it is returned from the forge call. This function will do all the necessary parsing and formatting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func parse(hashToParse: String, metadata: OperationMetadata) -> RPC<[OperationPayload]>?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == [OperationResponse] +

+
+
+ +
+
+
+ + +
+ +

Available where T == OperationResponse +

+
+
+ +
+
+
+ + +
+ +

Available where T == Data +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch a contracts Michelson storage

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func contractStorage(contractAddress: String) -> RPC<Data>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bigMap(id:) + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the contents of the given big map

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func bigMap(id: String) -> RPC<Data>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/RegularWallet.html b/Classes/RegularWallet.html new file mode 100644 index 00000000..29e3a4aa --- /dev/null +++ b/Classes/RegularWallet.html @@ -0,0 +1,1215 @@ + + + + RegularWallet Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

RegularWallet

+
+
+ +
public class RegularWallet : Wallet
+
extension RegularWallet: Equatable
+
extension RegularWallet: Hashable
+ +
+
+

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

+ +

This wallet is a non-HD wallet, sometimes referred to as a “legacy” wallet. It follows the Bip39 standard for generation via menmonic.

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    enum used to differientate wallet class types. Needed for applications that allow users to create many different types of wallets

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: WalletType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The TZ1 or TZ2 address of the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKey + +
    +
    +
    +
    +
    +
    +

    An object representing the PrivateKey used to generate the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var privateKey: PrivateKey
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    +

    An object representing the PublicKey used to generate the wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var publicKey: PublicKey
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mnemonic + +
    +
    +
    +
    +
    +
    +

    Optional Bip39 mnemonic used to generate the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var mnemonic: Mnemonic?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Attempt to create an instance of a RegularWallet from an encoded string containing a private key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(secp256k1WithBase58String base58String: String, type: WalletType)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + secp256k1WithBase58String + + +
    +

    String containing the Base58 encoded private key, prefixed with the curve’s secret

    +
    +
    + + type + + +
    +

    WalletType indicating the top most type of wallet

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a RegularWallet by supplying a Mnemonic and a passphrase (or “” if none).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(withMnemonic mnemonic: Mnemonic, passphrase: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + withMnemonic + + +
    +

    A Mnemonic representing a BIP39 menmonic

    +
    +
    + + passphrase + + +
    +

    String contianing a passphrase, or empty string if none

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a RegularWallet by asking for a mnemonic of a given number of words and a passphrase (or “” if none).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(withMnemonicLength length: Mnemonic.NumberOfWords, passphrase: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + withMnemonicLength + + +
    +

    Mnemonic.NumberOfWords the number of words to use when creating a mnemonic

    +
    +
    + + passphrase + + +
    +

    String contianing a passphrase, or empty string if none

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Crypto Functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Sign a hex payload with the private key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKeyCurve() + +
    +
    +
    +
    +
    +
    +

    Return the curve used to create the key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func privateKeyCurve() -> EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a Base58 encoded version of the public key, in order to reveal the address on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func publicKeyBase58encoded() -> String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: RegularWallet, rhs: RegularWallet) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/TaquitoService.html b/Classes/TaquitoService.html new file mode 100644 index 00000000..1f0a2d1f --- /dev/null +++ b/Classes/TaquitoService.html @@ -0,0 +1,932 @@ + + + + TaquitoService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TaquitoService

+
+
+ +
public class TaquitoService
+ +
+
+

Taquito (https://github.com/ecadlabs/taquito) is a popular open source Tezos library written in Typescript and Javascript. +Taquito is made up of many separate packages that deal with various aspects of Tezos RPC and Michelson. +This serivce class is a wrapper around a small piece of the Taquito library to expose funtionality that would otherwise be time consuming/risky/dangerous to re-implement natively. +The JS can now be found on each github release here: https://github.com/ecadlabs/taquito/releases/, by extracting the zip named “taquito-local-forging-vanilla.zip”

+ +
+
+
+
    +
  • +
    + + + + TaquitoServiceError + +
    +
    +
    +
    +
    +
    +

    Unique TaquitoService errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TaquitoServiceError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Public shared instace to avoid having multiple copies of the underlying JSContext created

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let shared: TaquitoService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

@taquito/local-forging +

+
+
+ +
+
+
+ +
+
+ + diff --git a/Classes/TaquitoService/TaquitoServiceError.html b/Classes/TaquitoService/TaquitoServiceError.html new file mode 100644 index 00000000..c29aa21e --- /dev/null +++ b/Classes/TaquitoService/TaquitoServiceError.html @@ -0,0 +1,793 @@ + + + + TaquitoServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TaquitoServiceError

+
+
+ +
public enum TaquitoServiceError : Error
+ +
+
+

Unique TaquitoService errors

+ +
+
+
+
    +
  • +
    + + + + alreadyForging + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case alreadyForging
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + alreadyParsing + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case alreadyParsing
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/TezosDomainsClient.html b/Classes/TezosDomainsClient.html new file mode 100644 index 00000000..c88fc446 --- /dev/null +++ b/Classes/TezosDomainsClient.html @@ -0,0 +1,1028 @@ + + + + TezosDomainsClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsClient

+
+
+ +
public class TezosDomainsClient
+ +
+
+

A client class allowing integration with the tezos domains GraphQL API. See more here: https://tezos.domains/

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Object to wrap up a response fomr both networks

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BothNetworkReverseRecord
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Public single functions +

+
+
+ +
+
+
+ + +
+ +

Public bulk functions +

+
+
+ +
+
+
+ +
+
+ + diff --git a/Classes/TezosDomainsClient/BothNetworkReverseRecord.html b/Classes/TezosDomainsClient/BothNetworkReverseRecord.html new file mode 100644 index 00000000..bd940bdf --- /dev/null +++ b/Classes/TezosDomainsClient/BothNetworkReverseRecord.html @@ -0,0 +1,819 @@ + + + + BothNetworkReverseRecord Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BothNetworkReverseRecord

+
+
+ +
public struct BothNetworkReverseRecord
+ +
+
+

Object to wrap up a response fomr both networks

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Classes/TezosNodeClient.html b/Classes/TezosNodeClient.html new file mode 100644 index 00000000..17ca5f8d --- /dev/null +++ b/Classes/TezosNodeClient.html @@ -0,0 +1,1626 @@ + + + + TezosNodeClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosNodeClient

+
+
+ +
public class TezosNodeClient
+ +
+
+

The TezosNodeClient offers methods for interacting with the Tezos node to fetch balances, send transactions etc. +The client will abstract away all the compelx tasks of remote forging, parsing, signing, preapply and injecting operations. +It will also convert amounts from the network into Token objects to make common tasks easier.

+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + config + +
    +
    +
    +
    +
    +
    +

    The configuration object containing all the necessary settings to connect and communicate with the Tezos node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let config: TezosNodeClientConfig
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkService + +
    +
    +
    +
    +
    +
    +

    The NetworkService object that will perform all the networking calls

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var networkService: NetworkService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationService + +
    +
    +
    +
    +
    +
    +

    The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var operationService: OperationService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + feeEstimatorService + +
    +
    +
    +
    +
    +
    +

    The service responsible for calculating network fees on behalf of the user

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var feeEstimatorService: FeeEstimatorService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkVersion + +
    +
    +
    +
    +
    +
    +

    Available information about the version of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var networkVersion: NetworkVersion?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkConstants + +
    +
    +
    +
    +
    +
    +

    Available information about the constants of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var networkConstants: NetworkConstants?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosNodeClientError + +
    +
    +
    +
    +
    +
    +

    Types of errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TezosNodeClientError : Error
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • +
    + + + + init(config:) + +
    +
    +
    +
    +
    +
    +

    Init a TezosNodeClient with a TezosNodeClientConfig.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(config: TezosNodeClientConfig = TezosNodeClientConfig(withDefaultsForNetworkType: .mainnet))
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + config + + +
    +

    A configuration object containing all the necessary settings to connect and communicate with the Tezos node.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Balance +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Gets the xtz balance for a given Address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBalance(forAddress address: String, completion: @escaping ((Result<XTZAmount, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    A Tezos network address, starting with "tz1", "tz2", "tz3" or "kt1"

    +
    +
    + + completion + + +
    +

    A callback containing a new Token object matching the xtz standard, or an error.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Delegate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Gets the delegate for the given address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getDelegate(forAddress address: String, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    A Tezos network address, starting with "tz1", "tz2", "tz3" or "kt1"

    +
    +
    + + completion + + +
    +

    A callback containing a String with the delegate/baker’s address, or an error.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Estimate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Take an array of operations and estimate the gas, storage, baker fee and burn fees required to inject it onto the network +If the supplied operations contain suggested fees (e.g. from a dApp) this function will estimate the fee and pick which ever is higher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func estimate(operations: [Operation], walletAddress: String, base58EncodedPublicKey: String, completion: @escaping ((Result<FeeEstimatorService.EstimationResult, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + operations + + +
    +

    An array of Operation‘s to be injected.

    +
    +
    + + wallet + + +
    +

    The Wallet that will sign the operation

    +
    +
    + + completion + + +
    +

    A callback containing an updated array of Operation‘s with fees set correctly, or an error.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Send +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Send an array of Operation‘s to the blockchain. Use OperationFactory to help create this array for common use cases.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func send(operations: [Operation], withWallet wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + operations + + +
    +

    An array of Operation subclasses to be sent to the network.

    +
    +
    + + withWallet + + +
    +

    The Wallet instance that will sign the transactions.

    +
    +
    + + completion + + +
    +

    A completion closure that will either return the opertionID of an injected operation, or an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Send an already contrsutructed OperationPayload with the necessary OperationMetadata without having to fetch metadata again.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func send(operationPayload: OperationPayload, operationMetadata: OperationMetadata, withWallet wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + operationPayload + + +
    +

    An OperationPayload that has already been constructed (e.g. from the estimation call).

    +
    +
    + + operationMetadata + + +
    +

    An OperationMetaData object containing all the info about the network that the call needs for forge -> inject.

    +
    +
    + + withWallet + + +
    +

    The Wallet instance that will sign the transactions.

    +
    +
    + + completion + + +
    +

    A completion closure that will either return the opertionID of an injected operation, or an error.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Blockchain Operations +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get all the metadata necessary from the network to perform operations.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getOperationMetadata(forWalletAddress: String, completion: @escaping ((Result<OperationMetadata, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forWallet + + +
    +

    The Wallet object that will be sending the operations.

    +
    +
    + + completion + + +
    +

    A callback that will be executed when the network requests finish.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the Michelson storage of a given contract from the blockchain.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getContractStorage(contractAddress: String, completion: @escaping ((Result<[String : Any], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + contractAddress + + +
    +

    The address of the contract to query.

    +
    +
    + + completion + + +
    +

    A callback with a Result object, with either a [String: Any] or an Error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the Michelson big map contents, from a given id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBigMap(id: String, completion: @escaping ((Result<[String : Any], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + id + + +
    +

    The big map id.

    +
    +
    + + completion + + +
    +

    A callback with a Result object, with either a [String: Any] or an Error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Query the server for the NetworkVersion and NetworkConstants, and store the responses in the tezosNodeClient properties networkVersion and networkConstants, +so they can be referred too by the application without having to constantly query t he server.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getNetworkInformation(completion: @escaping ((Bool, KukaiError?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    A callback with a Bool indicating success and an optional Error

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/TezosNodeClient/TezosNodeClientError.html b/Classes/TezosNodeClient/TezosNodeClientError.html new file mode 100644 index 00000000..3b973b37 --- /dev/null +++ b/Classes/TezosNodeClient/TezosNodeClientError.html @@ -0,0 +1,793 @@ + + + + TezosNodeClientError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosNodeClientError

+
+
+ +
public enum TezosNodeClientError : Error
+ +
+
+

Types of errors

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noDexterExchangeAddressFound
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonParsing + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case michelsonParsing
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/Token.html b/Classes/Token.html new file mode 100644 index 00000000..3a90714a --- /dev/null +++ b/Classes/Token.html @@ -0,0 +1,1631 @@ + + + + Token Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Token

+
+
+ +
public class Token : Codable, CustomStringConvertible
+
extension Token: Equatable
+
extension Token: Hashable
+
extension Token: Identifiable
+ +
+
+

A class to represent a Token on the Tezos network. This class will do all the heavy lifting of converting values from the RPC to more human readbale values. +This class will also handle arithmetic functions, allowing developers to add and subtract tokens (useful when caluclating fees and total values).

+ +
+
+
+
    +
  • +
    + + + + TokenType + +
    +
    +
    +
    +
    +
    +

    An Enum to express the type of a token. Different processes are needed to fetch a balance for a users XTZ wallet, +versus fetching a FA1.2 token balance. This allows the library to abstract this logic away from the user and handle it all behind the scenes.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TokenType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The long name of a token. e.g. “Tezos”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    +

    The short name or the symbol of a token. e.g. “XTZ”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenType + +
    +
    +
    +
    +
    +
    +

    The type of this token. e.g. xtz, fungible, nonfungible

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenType: TokenType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + faVersion + +
    +
    +
    +
    +
    +
    +

    The FaVersion of the token contract, nil for XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let faVersion: FaVersion?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    Object that holds and formats the balance of the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var balance: TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimalPlaces + +
    +
    +
    +
    +
    +
    +

    Get the underlying number of decimal places that this token represents

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimalPlaces: Int { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + thumbnailURL + +
    +
    +
    +
    +
    +
    +

    The URL to a cached version of the asset (data that we add later on through other service calls)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var thumbnailURL: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + localCurrencyRate + +
    +
    +
    +
    +
    +
    +

    The current local currency rate of this token. Used to show the user the net worth of their holdings.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var localCurrencyRate: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenContractAddress + +
    +
    +
    +
    +
    +
    +

    In the case of FA1.2 or higher, we need to know the KT1 address for the token so we can fetch balances and make trades. (should be empty for xtz).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenContractAddress: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    +

    Each token type on a contract will have a unique token_id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tokenId: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isHidden + +
    +
    +
    +
    +
    +
    +

    Recording if the user has marked the token as hidden

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isHidden: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + favouriteSortIndex + +
    +
    +
    +
    +
    +
    +

    Recording if the position the index the user chose for the favourite token to appear

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var favouriteSortIndex: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nfts + +
    +
    +
    +
    +
    +
    +

    The individual NFT’s owned of this token type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var nfts: [NFT]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mintingTool + +
    +
    +
    +
    +
    +
    +

    The URL of the tool used to mint the item

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var mintingTool: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFavourite + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isFavourite: Bool { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Init a Token object that will hold all the necessary data to interact with the Tezos network, and the Dexter exchange

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(name: String?, symbol: String, tokenType: TokenType, faVersion: FaVersion?, balance: TokenAmount, thumbnailURL: URL?, tokenContractAddress: String?, tokenId: Decimal?, nfts: [NFT]?, mintingTool: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + name + + +
    +

    The long name of the token. e.g. “Tezos”

    +
    +
    + + symbol + + +
    +

    The short name of the token, or the symbol. e.g. “XTZ”

    +
    +
    + + tokenType + + +
    +

    The type of the token. e.g. xtz, fa1.2, fa2 etc.

    +
    +
    + + faVersion + + +
    +

    The FA standard / version used to create this token.

    +
    +
    + + decimalPlaces + + +
    +

    The number of decimal places this token contains.

    +
    +
    + + thumbnailURI + + +
    +

    URI to network asset to use to display an icon for the token

    +
    +
    + + tokenContractAddress + + +
    +

    The KT1 address of the contract (nil if xtz).

    +
    +
    + + tokenId + + +
    +

    The token id if the token is an FA2 token, nil otherwise.

    +
    +
    + + nfts + + +
    +

    The individual NFT’s owned of this token type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init a Token from an object returned by the TzKT API

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from: TzKTBalanceToken, andTokenAmount: TokenAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Init a Token from an object returned by the TzKT API

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from: TzKTTokenTransfer)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtz() + +
    +
    +
    +
    +
    +
    +

    Create a Token object with all the settings needed for XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func xtz() -> Token
    + +
    +
    +
    +

    Return Value

    +

    Token

    +
    +
    +
    +
  • +
  • +
    + + + + xtz(withAmount:) + +
    +
    +
    +
    +
    +
    +

    Create a Token object with all the settings needed for XTZ, with an initial amount. Useful for setting fees.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func xtz(withAmount amount: TokenAmount) -> Token
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + withAmount + + +
    +

    The Amount of XTZ to create the Token with.

    +
    +
    +
    +
    +

    Return Value

    +

    Token.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Useful for creating placeholders for pending activity items

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func placeholder(fromNFT nft: NFT, amount: TokenAmount, thumbnailURL: URL?) -> Token
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isXTZ() + +
    +
    +
    +
    +
    +
    +

    Helper function to check if the Token instance being passed aroun is pointing to XTZ. As many functions will require different functionality for fa token versus XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isXTZ() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: Token, rhs: Token) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    +

    Conforming to Identifiable to enable working with ForEach and similiar looping functions + if faVersion present, use that to follow the standard of either tokenAddress or combination of tokenAddress + token id, fallback to using symbol if type is unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var id: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/Token/TokenType.html b/Classes/Token/TokenType.html new file mode 100644 index 00000000..88659098 --- /dev/null +++ b/Classes/Token/TokenType.html @@ -0,0 +1,820 @@ + + + + TokenType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TokenType

+
+
+ +
public enum TokenType : String, Codable
+ +
+
+

An Enum to express the type of a token. Different processes are needed to fetch a balance for a users XTZ wallet, +versus fetching a FA1.2 token balance. This allows the library to abstract this logic away from the user and handle it all behind the scenes.

+ +
+
+
+
    +
  • +
    + + + + xtz + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case xtz
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fungible + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fungible
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nonfungible + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case nonfungible
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/TokenAmount.html b/Classes/TokenAmount.html new file mode 100644 index 00000000..ffcb1540 --- /dev/null +++ b/Classes/TokenAmount.html @@ -0,0 +1,1612 @@ + + + + TokenAmount Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TokenAmount

+
+
+ +
public class TokenAmount : Codable
+
extension TokenAmount: Comparable
+
extension TokenAmount: Equatable
+
extension TokenAmount: CustomStringConvertible
+
extension TokenAmount: Hashable
+ +
+
+

Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length. +This class is used to encapsulate a BigInt and provide all the necessary init’s and formatting functions to work with the networks requirements.

+ +
+
+
+
    +
  • +
    + + + + TokenAmountError + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TokenAmountError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimalPlaces + +
    +
    +
    +
    +
    +
    +

    The number of decimal places that this token supports.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimalPlaces: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + rpcRepresentation + +
    +
    +
    +
    +
    +
    +

    Format the internal value to ensure it matches the format the RPC will expect

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var rpcRepresentation: String { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Basic formatting of a token to be human readable. For more advanced options, use the format function

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var normalisedRepresentation: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(fromRpcAmount rpcAmount: String, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromRpcAmount + + +
    +

    A string conforming to the RPC standard for the given token.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a decimal version of an RPC amount. e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(fromRpcAmount rpcAmount: Decimal, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromRpcAmount + + +
    +

    A decimal conforming to the RPC standard for the given token. Decimal places will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(fromNormalisedAmount normalisedAmount: Decimal, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNormalisedAmount + + +
    +

    A decimal containing an amount for the given token. Anything over the given decimal places for the token will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(fromNormalisedAmount normalisedAmount: String, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNormalisedAmount + + +
    +

    A string containing an amount for the given token. Anything over the given decimal places for the token will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + zero() + +
    +
    +
    +
    +
    +
    +

    Quickly create a TokenAmount with zero balance and no decimal places. +Warning: the decimal places attribute could be used by other code to determine precision. This should only be used in places where it is needed as a temporary, default value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class func zero() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Quickly create a TokenAmount with zero balance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class func zeroBalance(decimalPlaces: Int) -> TokenAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable +

+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info. +This coder attempts to handle both states, first checking if its possible to extract both, if not, defaulting the decimal palces to zero, expecting the calling application to provide this information later on from another proptery or even another API call (such as a metadata query)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    required public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Display +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Format the current value into a human readable string, using the given locale.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func formatNormalisedRepresentation(locale: Locale) -> String?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + locale + + +
    +

    The locale to use to decide whether to use decimal or comma, comma or spaces etc, when formattting the number

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + toRpcDecimal() + +
    +
    +
    +
    +
    +
    +

    Function to convert the underlying rpc value into a Decimal which can be useful in some situations for integrating with other tools and frameworks. +Warning Decimal has a limited, lower treshold (163 digits). Its possible it can overrun, hence the optional return value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func toRpcDecimal() -> Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + toNormalisedDecimal() + +
    +
    +
    +
    +
    +
    +

    Function to convert the underlying normalised value into a Decimal which can be useful in some situations for integrating with other tools and frameworks. +Warning Decimal has a limited, lower treshold (163 digits). Its possible it can overrun, hence the optional return value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func toNormalisedDecimal() -> Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + toXTZAmount() + +
    +
    +
    +
    +
    +
    +

    Currently we are unable to cast directly from TokenAmount to XTZAmount. This function will create a new XTZAmount object from the TokenAmount. +THis is useful in situations where an amount is passed in a generic manner as a TokenAmount, but its required to be an XTZAmount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func toXTZAmount() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Arithmetic +

+
+
+
    +
  • +
    + + + + +(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload + operator to allow users to add two Token amounts of the same type, together.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func + (lhs: TokenAmount, rhs: TokenAmount) -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + +=(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload += operator to allow users to add two Token amounts of the same type, together in place.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func += (lhs: inout TokenAmount, rhs: TokenAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + -(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload - operator to allow users to subtract two Token amounts of the same type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func - (lhs: TokenAmount, rhs: TokenAmount) -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + -=(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func -= (lhs: inout TokenAmount, rhs: TokenAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + *(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func * (lhs: TokenAmount, rhs: Decimal) -> Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + *(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func * (lhs: TokenAmount, rhs: Int) -> TokenAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Extensions +

+
+
+
    +
  • +
    + + + + <(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Comparable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func < (lhs: TokenAmount, rhs: TokenAmount) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: TokenAmount, rhs: TokenAmount) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/TokenAmount/TokenAmountError.html b/Classes/TokenAmount/TokenAmountError.html new file mode 100644 index 00000000..3c316615 --- /dev/null +++ b/Classes/TokenAmount/TokenAmountError.html @@ -0,0 +1,766 @@ + + + + TokenAmountError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TokenAmountError

+
+
+ +
public enum TokenAmountError : Error
+ +
+
+ +
+
+
+
    +
  • +
    + + + + invalidStringFromRPC + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidStringFromRPC
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/TorusAuthService.html b/Classes/TorusAuthService.html new file mode 100644 index 00000000..6ea9cefb --- /dev/null +++ b/Classes/TorusAuthService.html @@ -0,0 +1,1126 @@ + + + + TorusAuthService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TorusAuthService

+
+
+ +
public class TorusAuthService : NSObject
+
extension TorusAuthService: ASAuthorizationControllerDelegate, ASAuthorizationControllerPresentationContextProviding
+ +
+
+

TorusAuthService is a wrapper around the SDK provided by: https://tor.us/ to allow the creation of TorusWallet‘s. +This allows users to create a wallet from their social media accounts without having to use a seed phrase / mnemonic. +TorusAuthService allows Tezos apps to leverage this service for a number of providers, and also has the ability to query the network for someone else’s wallet address, +based on their social profile. This allows you to send XTZ or tokens to your friend based on their twitter username for example

+ +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Setup the TorusAuthService verifiers and networking clients for testnet and mainnet, so they can be queried easier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(networkService: NetworkService, verifiers: [TorusAuthProvider : SubverifierWrapper])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + networkService + + +
    +

    A networking service instance used for converting twitter handles into twitter id’s

    +
    +
    + + verifiers + + +
    +

    List of verifiers available to the library for the given app context

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a TorusWallet insteace from a social media provider

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func createWallet(from authType: TorusAuthProvider, displayOver: UIViewController?, mockedTorus: CustomAuth? = nil, completion: @escaping ((Result<TorusWallet, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + from + + +
    +

    The TorusAuthProvider that you want to invoke

    +
    +
    + + displayOver + + +
    +

    The UIViewController that the webpage will display on top of

    +
    +
    + + mockedTorus + + +
    +

    To avoid issues attempting to stub aspects of the Torus SDK, a mocked version of the SDK can be supplied instead

    +
    +
    + + completion + + +
    +

    The callback returned when all the networking and cryptography is complete

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a TZ2 address from a social media user name. If Twitter, will first convert the username to a userid and then query

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAddress(from authType: TorusAuthProvider, for socialUsername: String, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + from + + +
    +

    The TorusAuthProvider that you want to invoke

    +
    +
    + + for + + +
    +

    The social media username to search for

    +
    +
    + + completion + + +
    +

    The callback returned when all the networking and cryptography is complete

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Take in a Twitter username and fetch the Twitter userId instead.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func twitterLookup(username: String, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + username + + +
    +

    The users username. Can contain an @ symbol, but will be stripped out by the code as its not required

    +
    +
    + + completion + + +
    +

    The callback fired when the userId has been found

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+ +
+
+
+ +
+
+ + diff --git a/Classes/TorusWallet.html b/Classes/TorusWallet.html new file mode 100644 index 00000000..f4f71b40 --- /dev/null +++ b/Classes/TorusWallet.html @@ -0,0 +1,1010 @@ + + + + TorusWallet Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TorusWallet

+
+
+ +
public class TorusWallet : RegularWallet
+ +
+
+

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

+ +

This wallet is a subclass of LinearWallet created by using the Torus network to generate wallets from social media accounts. +This class is equivalent to a LinearWallet producing a TZ2 address via secp256k1, without the use of a mnemonic, and instead including the social profile of the user.

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + authProvider + +
    +
    +
    +
    +
    +
    +

    The type of service used to generate the provide key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let authProvider: TorusAuthProvider
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + socialUsername + +
    +
    +
    +
    +
    +
    +

    The raw social media username displayed on the users account. In the case of Twitter, it will not be prefix with an @

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let socialUsername: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + socialUserId + +
    +
    +
    +
    +
    +
    +

    The unique id the social media platform has assigned to the users account. Used for querying account details

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let socialUserId: String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A URL to the users profile picture on the given social meida platform

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let socialProfilePictureURL: URL?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create an instace of the wallet from the data provided by the Torus network, using TorusAuthService

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(authProvider: TorusAuthProvider, username: String?, userId: String?, profilePicture: String?, torusPrivateKey: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + authProvider + + +
    +

    The supported provider used to create the private key

    +
    +
    + + username + + +
    +

    Optional, the users social profile username

    +
    +
    + + userId + + +
    +

    Optional, the users social profile unique id

    +
    +
    + + profilePicture + + +
    +

    Optional, the users social profile display image

    +
    +
    + + torusPrivateKey + + +
    +

    The hex encoded private key from the Torus network

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable +

+
+
+
    +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Encodable encode func

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/TzKTClient.html b/Classes/TzKTClient.html new file mode 100644 index 00000000..a5156f42 --- /dev/null +++ b/Classes/TzKTClient.html @@ -0,0 +1,2072 @@ + + + + TzKTClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTClient

+
+
+ +
public class TzKTClient
+
extension TzKTClient: HubConnectionDelegate
+ +
+
+

TzKT is an indexer for Tezos, who’s API allows developers to query details about wallets, transactions, bakers, account status etc

+ +
+
+
+
    +
  • +
    + + + + TzKTServiceError + +
    +
    +
    +
    +
    +
    +

    Unique Errors that TzKTClient can throw

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TzKTServiceError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Constants + +
    +
    +
    +
    +
    +
    +

    Constants needed for interacting with the API

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Constants
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isListening + +
    +
    +
    +
    +
    +
    +

    Is currently monitoring an address for update notifications

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isListening: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + accountDidChange + +
    +
    +
    +
    +
    +
    +

    Notifications of monitored addresses that have changed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    @Published
    +public var accountDidChange: [String] { get set }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Storage +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get the storage of a given contract and parse it to a supplied model type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getStorage<T>(forContract contract: String, ofType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable, T : Encodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + forContract + + +
    +

    The KT1 contract address to query

    +
    +
    + + ofType + + +
    +

    The Codable compliant model to parse the response as

    +
    +
    + + completion + + +
    +

    A completion block called, returning a Swift Result type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the keys of a big map, by ID and parse it to a model

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBigMap<T>(forId id: String, ofType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable, T : Encodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + forId + + +
    +

    The numeric ID of the big map

    +
    +
    + + ofType + + +
    +

    The Codable compliant model to parse the response as

    +
    +
    + + completion + + +
    +

    A completion block called, returning a Swift Result type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the keys of a big map, but filtered to only one specific key. Parse the response as the supplied model

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBigMapKey<T>(forId id: String, key: String, ofType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable, T : Encodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + forId + + +
    +

    The numeric ID of the big map

    +
    +
    + + key + + +
    +

    The key to filter by

    +
    +
    + + ofType + + +
    +

    The Codable compliant model to parse the response as

    +
    +
    + + completion + + +
    +

    A completion block called, returning a Swift Result type

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Search +

+
+
+ +
+
+
+ + +
+ +

Baking and Rewards +

+
+
+ +
+
+
+ + +
+ +

Network +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Call https://api.tzkt.io/v1/cycles?limit=… to get the 10 most recent cycles

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func cycles(limit: Int = 25, completion: @escaping ((Result<[TzKTCycle], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Given a list of cycles, search through them to find what cycle a given block level appeared in +If leveled supplied is less than the firstLevel of the last cycle, return the last

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func cycleForLevel(cycles: [TzKTCycle], level: Decimal) -> TzKTCycle?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Block checker +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Query details about the given operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getOperation(byHash hash: String, completion: @escaping (([TzKTOperation]?, KukaiError?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + byHash + + +
    +

    The operation hash to query.

    +
    +
    + + completion + + +
    +

    A completion colsure called when the request is done.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Account monitoring +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Open a websocket connection to request a notification for any changes to the given account. The @Published var accountDidChange will be notified if something occurs

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func listenForAccountChanges(addresses: [String], withDebugging: Bool = false)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + address + + +
    +

    The Tz address of the account to monitor

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Close the websocket from listenForAccountChanges

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func stopListeningForAccountChanges()
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Close the current connection and open another

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func changeAddressToListenForChanges(addresses: [String])
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Balances +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get the count of tokens the given address has balances for (excluding zero balances)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBalanceCount(forAddress: String, completion: @escaping (Result<Int, KukaiError>) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    The tz address to search for

    +
    +
    + + completion + + +
    +

    The completion block called with a Result containing the number or an error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Tokens balances and metadata need to be fetch from a paginated API. THis function calls a sinlerequest or 1 page of balances / metadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBalancePage(forAddress: String, offset: Int = 0, completion: @escaping ((Result<[TzKTBalance], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + forAddress + + +
    +

    The tz address to search for

    +
    +
    + + offset + + +
    +

    The starting position

    +
    +
    + + completion + + +
    +

    The completion block called with a Result containing an array of balances or an error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the account object from TzKT caontaining information about the address, its balance and baker

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAccount(forAddress: String, completion: @escaping ((Result<TzKTAccount, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    The tz address to search for

    +
    +
    + + completion + + +
    +

    The completion block called with a Result containing an object or an error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get all balances from one function call, by fetching the result from getBalanceCount and using that to decide how many pages should be called

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAllBalances(forAddress address: String, completion: @escaping ((Result<Account, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    The tz address to search for

    +
    +
    + + completion + + +
    +

    The completion block called with a Result containing an object or an error

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + avatarURL(forToken:) + +
    +
    +
    +
    +
    +
    +

    In order to access the cached images, you need the URL it was downloaded from. This can either be found inside the Token objects returned as part of Account from the fetchAccountInfo func. +Or, if you need to use it seperately, given the token address you can use this function

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func avatarURL(forToken token: String) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + forToken + + +
    +

    The token address who’s image you are looking for.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Transaction History +

+
+
+ +
+
+
+ +
+
+ + diff --git a/Classes/TzKTClient/Constants.html b/Classes/TzKTClient/Constants.html new file mode 100644 index 00000000..efba39b3 --- /dev/null +++ b/Classes/TzKTClient/Constants.html @@ -0,0 +1,767 @@ + + + + Constants Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Constants

+
+
+ +
public struct Constants
+ +
+
+

Constants needed for interacting with the API

+ +
+
+
+
    +
  • +
    + + + + tokenBalanceQuerySize + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tokenBalanceQuerySize: Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/TzKTClient/TzKTServiceError.html b/Classes/TzKTClient/TzKTServiceError.html new file mode 100644 index 00000000..cbc7c74d --- /dev/null +++ b/Classes/TzKTClient/TzKTServiceError.html @@ -0,0 +1,793 @@ + + + + TzKTServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTServiceError

+
+
+ +
public enum TzKTServiceError : Error
+ +
+
+

Unique Errors that TzKTClient can throw

+ +
+
+
+
    +
  • +
    + + + + invalidURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidURL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseError(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parseError(String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/WalletCacheService.html b/Classes/WalletCacheService.html new file mode 100644 index 00000000..34aef45f --- /dev/null +++ b/Classes/WalletCacheService.html @@ -0,0 +1,1369 @@ + + + + WalletCacheService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletCacheService

+
+
+ +
public class WalletCacheService
+ +
+
+

A service class used to store and retrieve Wallet objects such as RegularWallet, HDWallet, LedgerWallet and TorusWallet from the devices disk. +This class will use the secure enclave (keychain if not available) to generate a key used to encrypt the contents locally, and retrieve. +This class will also store non senstiivve “metadata” about wallets, to allow storage of UI related data users might want to add, without cluttering up the wallet objects themselves

+ +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    +

    Empty

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init()
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Storage and Retrieval +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Securely cache a walelt object, and record a default metadata object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func cache<T>(wallet: T, childOfIndex: Int?, backedUp: Bool) -> Bool where T : Wallet
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + wallet + + +
    +

    An object conforming to Wallet to be stored

    +
    +
    + + childOfIndex + + +
    +

    An optional Int to denote the index of the HD wallet that this wallet is a child of

    +
    +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the storage was successful or not

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Cahce a watch wallet metadata obj, only. Metadata cahcing handled via wallet cache method

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func cacheWatchWallet(metadata: WalletMetadata) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Delete both a secure wallet entry and its related metadata object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteWallet(withAddress: String, parentIndex: Int?) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + withAddress + + +
    +

    The address of the wallet

    +
    +
    + + parentIndex + + +
    +

    An optional Int to denote the index of the HD wallet that this wallet is a child of

    +
    +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the storage was successful or not

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Clear a watch wallet meatadata obj from the metadata cache only, does not affect actual wallet cache

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteWatchWallet(address: String) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Find and return the secure object for a given address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func fetchWallet(forAddress address: String) -> Wallet?
    + +
    +
    +
    +

    Return Value

    +

    Optional object confirming to Wallet protocol

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Delete the cached files and the assoicate keys used to encrypt it

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteAllCacheAndKeys() -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the process was successful or not

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Read and Write +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Take a dictionary of Wallet objects with their addresses as the key, serialise to JSON, encrypt and then write to disk

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encryptAndWriteWalletsToDisk(wallets: [String : Wallet]) -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the process was successful

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Go to the file on disk (if present), decrypt its contents and retrieve a dictionary of `Wallet’s with the key being the wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func readWalletsFromDiskAndDecrypt() -> [String : Wallet]?
    + +
    +
    +
    +

    Return Value

    +

    A dictionary of Wallet if present on disk

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Write an ordered array of WalletMetadata to disk, replacing existing file if exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encryptAndWriteMetadataToDisk(_ metadata: WalletMetadataList) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return an ordered array of WalletMetadata if present on disk

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func readMetadataFromDiskAndDecrypt() -> WalletMetadataList
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Encryption +

+
+
+
    +
  • +
    + + + + loadOrCreateKeys() + +
    +
    +
    +
    +
    +
    +

    Load the key references from the secure enclave (or keychain), or create them if non exist

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func loadOrCreateKeys() -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if operation was successful

    +
    +
    +
    +
  • +
  • +
    + + + + unloadKeys() + +
    +
    +
    +
    +
    +
    +

    Clear the key refrences

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func unloadKeys()
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + deleteKey() + +
    +
    +
    +
    +
    +
    +

    Delete a key from the secure enclave

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteKey() throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encrypt(_:) + +
    +
    +
    +
    +
    +
    +

    Encrypts string using the Secure Enclave

    +
    +

    Throws

    + CryptoKit error + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encrypt(_ string: String) throws -> Data
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + string + + +
    +

    clear text to be encrypted

    +
    +
    +
    +
    +

    Return Value

    +

    cipherText encrypted string

    +
    +
    +
    +
  • +
  • +
    + + + + decrypt(_:) + +
    +
    +
    +
    +
    +
    +

    Decrypts cipher text using the Secure Enclave

    +
    +

    Throws

    + CryptoKit error + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func decrypt(_ cipherText: Data) throws -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cipherText + + +
    +

    encrypted cipher text

    +
    +
    +
    +
    +

    Return Value

    +

    cleartext string

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Classes/XTZAmount.html b/Classes/XTZAmount.html new file mode 100644 index 00000000..f7c4ceb2 --- /dev/null +++ b/Classes/XTZAmount.html @@ -0,0 +1,1169 @@ + + + + XTZAmount Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

XTZAmount

+
+
+ +
public class XTZAmount : TokenAmount
+ +
+
+

A subclass of TokenAmount to make it more explict when functions require XTZ (such as network fees). +It also serves as a means to more quickly create TokenAmount‘s conforming to XTZ.

+ +
+
+
+
    +
  • +
    + + + + init(fromRpcAmount:) + +
    +
    +
    +
    +
    +
    +

    Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(fromRpcAmount rpcAmount: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromRpcAmount + + +
    +

    A string conforming to the RPC standard for XTZ.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(fromRpcAmount:) + +
    +
    +
    +
    +
    +
    +

    Set the internal balance, using a decimal version of an RPC amount. e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(fromRpcAmount rpcAmount: Decimal)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromRpcAmount + + +
    +

    A decimal conforming to the RPC standard for XTZ. Decimal places will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(fromNormalisedAmount normalisedAmount: Decimal)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNormalisedAmount + + +
    +

    A decimal containing an amount for XTZ. Anything over the given decimal places for the token will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(fromNormalisedAmount normalisedAmount: String, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNormalisedAmount + + +
    +

    A string containing an amount for XTZ. Anything over the given decimal places for the token will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + zero() + +
    +
    +
    +
    +
    +
    +

    Quickly create a XTZAmount with zero balance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override class func zero() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable +

+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info. +This coder attempts to handle both states, first checking if its possible to extract both, if not, defaulting the decimal palces to zero, expecting the calling application to provide this information later on from another proptery or even another API call (such as a metadata query)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    required public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Arithmetic +

+
+
+
    +
  • +
    + + + + +(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload + operator to allow users to add two Token amounts of the same type, together.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func + (lhs: XTZAmount, rhs: XTZAmount) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + +=(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload += operator to allow users to add two Token amounts of the same type, together in place.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func += (lhs: inout XTZAmount, rhs: XTZAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + -(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload - operator to allow users to subtract two Token amounts of the same type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func - (lhs: XTZAmount, rhs: XTZAmount) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + -=(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func -= (lhs: inout XTZAmount, rhs: XTZAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + *(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func * (lhs: XTZAmount, rhs: Decimal) -> Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + *(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func * (lhs: XTZAmount, rhs: Int) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Collection/index.html b/Collection/index.html deleted file mode 100644 index 5b3e65ae..00000000 --- a/Collection/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - KukaiCoreSwift - Collection - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - Collection -

-
-

Methods

- -
-

- concatenate​Publishers() -

-
-
func concatenatePublishers() -> AnyPublisher<Element.Output, Element.Failure>?  
-
-
-

Convert an array of publishers into a concatenation, so that they will all run sequentually. Code from: https://www.apeth.com/UnderstandingCombine/operators/operatorsJoiners/operatorsappend.html

- -
-
-
-
-
- - - - diff --git a/ContentTypeCheckingImageDownloader/index.html b/ContentTypeCheckingImageDownloader/index.html deleted file mode 100644 index 8ab9e317..00000000 --- a/ContentTypeCheckingImageDownloader/index.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - KukaiCoreSwift - ContentTypeCheckingImageDownloader - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Content​Type​Checking​Image​Downloader -

- -
-
public class ContentTypeCheckingImageDownloader: ImageDownloader  
-
-
- -
- - - - - - -%115 - - - -ContentTypeCheckingImageDownloader - - -ContentTypeCheckingImageDownloader - - - - - -ImageDownloader - -ImageDownloader - - - -ContentTypeCheckingImageDownloader->ImageDownloader - - - - - - - - -
-

Conforms To

-
-
ImageDownloader
-
-
-
-

Methods

- -
-

- start​Download​Task(context:​callback:​) -

-
-
public override func startDownloadTask(context: DownloadingContext, callback: SessionDataTask.TaskCallback) -> DownloadTask  
-
-
-
- - - -
-
- - - - diff --git a/CurrentDevice/index.html b/CurrentDevice/index.html deleted file mode 100644 index bf0e7f92..00000000 --- a/CurrentDevice/index.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - KukaiCoreSwift - CurrentDevice - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Current​Device -

- -
-
public enum CurrentDevice  
-
-
-

Enum used to get details about the current device's capabilities

- -
- -
-

Properties

- -
-

- has​Secure​Enclave -

-
-
public static var hasSecureEnclave: Bool  
-
-
-

Does the current device have a secure enclave

- -
-
-
-

- is​Simulator -

-
-
public static var isSimulator: Bool  
-
-
-

Is the current device a simulator

- -
-
-
-
-

Methods

- -
-

- biometric​Type​Authorized() -

-
-
public static func biometricTypeAuthorized() -> BiometricType  
-
-
-
-

- biometric​Type​Supported() -

-
-
public static func biometricTypeSupported() -> BiometricType  
-
-
-
- - - -
-
- - - - diff --git a/DApp/index.html b/DApp/index.html deleted file mode 100644 index e462d9a0..00000000 --- a/DApp/index.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - KukaiCoreSwift - DApp - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - DApp -

- -
-
public struct DApp  
-
- - - - - -
-
- - - - diff --git a/DAppAccessType/index.html b/DAppAccessType/index.html deleted file mode 100644 index b473e08b..00000000 --- a/DAppAccessType/index.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - KukaiCoreSwift - DAppAccessType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - DApp​Access​Type -

- -
-
public enum DAppAccessType  
-
- -
-

Enumeration Cases

- -
-

- all -

-
-
case all
-
-
-
-

- direct​Auth​Only -

-
-
case directAuthOnly
-
-
-
-

- none -

-
-
case none
-
-
-
- - - -
-
- - - - diff --git a/DAppCategory/index.html b/DAppCategory/index.html deleted file mode 100644 index 4a5c44cf..00000000 --- a/DAppCategory/index.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - KukaiCoreSwift - DAppCategory - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - DApp​Category -

- -
-
public enum DAppCategory  
-
- -
-

Enumeration Cases

- -
-

- marketplace -

-
-
case marketplace
-
-
-
-

- exchange -

-
-
case exchange
-
-
-
-

- collectible -

-
-
case collectible
-
-
-
- - - -
-
- - - - diff --git a/DAppHelperService/index.html b/DAppHelperService/index.html deleted file mode 100644 index d30fac51..00000000 --- a/DAppHelperService/index.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - KukaiCoreSwift - DAppHelperService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - DApp​Helper​Service -

- -
-
public class DAppHelperService  
-
-
-

A Helper service to simply combine multiple calls from other services, and/or map to specific responses, in order to expose a piece of functionality provided by a dApp

- -
-
- - -

Nested Types

-
-
DAppHelperService.Quipuswap
-

All functions related to Quipuswap

-
-
-
- - - - -
-
- - - - diff --git a/DAppHelperService_Quipuswap/index.html b/DAppHelperService_Quipuswap/index.html deleted file mode 100644 index 363319be..00000000 --- a/DAppHelperService_Quipuswap/index.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - KukaiCoreSwift - DAppHelperService.Quipuswap - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - DApp​Helper​Service.​Quipuswap -

- -
-
public struct Quipuswap  
-
-
-

All functions related to Quipuswap

- -
-
- - -

Member Of

-
-
DAppHelperService
-

A Helper service to simply combine multiple calls from other services, and/or map to specific responses, in order to expose a piece of functionality provided by a dApp

-
-
-
-
-

Properties

- -
-

- FEE_FACTOR -

-
-
public static let FEE_FACTOR = 997
-
-
-

Constant pulled from: https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

- -
-
-
-

- VETO_PERIOD -

-
-
public static let VETO_PERIOD  
-
-
-

Constant pulled from: https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

- -
-
-
-

- VOTING_PERIOD -

-
-
public static let VOTING_PERIOD  
-
-
-

Constant pulled from:https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

- -
-
-
-

- ACCURANCY_MULTIPLIER -

-
-
public static let ACCURANCY_MULTIPLIER  
-
-
-

Constant pulled from: https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

- -
-
-
-
-

Methods

- -
-

- get​Pending​Rewards(from​Exchange:​for​Address:​tz​KTClient:​completion:​) -

-
-
public static func getPendingRewards(fromExchange exchange: String, forAddress address: String, tzKTClient: TzKTClient, completion: @escaping ((Result<XTZAmount, KukaiError>) -> Void))  
-
-
-

Use TzKTClient's methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

- -
-
-
-

- get​Pending​Rewards(from​Exchange:​for​Address:​tz​KTClient:​) -

-
-
public static func getPendingRewards(fromExchange exchange: String, forAddress address: String, tzKTClient: TzKTClient) -> Future<(exchange: String, rewards: XTZAmount), KukaiError>  
-
-
-

Wrapper around getPendingRewards(..., completion: ) to make it easier to create bulk queries, through combine

- -
-
-
-

- get​Bulk​Pending​Rewards(from​Exchanges:​for​Address:​tz​KTClient:​completion:​) -

-
-
public static func getBulkPendingRewards(fromExchanges exchanges: [String], forAddress address: String, tzKTClient: TzKTClient, completion: @escaping ((Result<[(exchange: String, rewards: XTZAmount)], KukaiError>) -> Void))  
-
-
-

Use TzKTClient's methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

- -
-
-
- - - -
-
- - - - diff --git a/Date/index.html b/Date/index.html deleted file mode 100644 index 82968cf8..00000000 --- a/Date/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - KukaiCoreSwift - Date - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - Date -

-
-

Methods

- -
-

- time​Ago​Display() -

-
-
func timeAgoDisplay() -> String  
-
-
-

Helper to return strings like "15 seconds ago", "1 minute ago" etc, from a Date

- -
-
-
-
-
- - - - diff --git a/DateFormatter/index.html b/DateFormatter/index.html deleted file mode 100644 index 6d0222b0..00000000 --- a/DateFormatter/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - KukaiCoreSwift - DateFormatter - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - DateFormatter -

-
-

Initializers

- -
-

- init(with​Format:​) -

-
-
convenience init(withFormat: String)  
-
-
-

Helper to create a DateFormatter with a format in 1 call

- -
-
-
-
-
- - - - diff --git a/Decimal/index.html b/Decimal/index.html deleted file mode 100644 index c24427d1..00000000 --- a/Decimal/index.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - KukaiCoreSwift - Decimal - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - Decimal -

-
-

Methods

- -
-

- rounded(scale:​rounding​Mode:​) -

-
-
func rounded(scale: Int, roundingMode: NSDecimalNumber.RoundingMode) -> Decimal  
-
-
-

Wrapper around the Objective-c code needed to round a Decimal

- -
-
-
-

- int​Value() -

-
-
func intValue() -> Int  
-
-
-

Wrapper around the Objective-c code needed to return an Int from a decimal

- -
-
-
-
-
- - - - diff --git a/DexAddCalculationResult/index.html b/DexAddCalculationResult/index.html deleted file mode 100644 index 803a9686..00000000 --- a/DexAddCalculationResult/index.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - KukaiCoreSwift - DexAddCalculationResult - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dex​Add​Calculation​Result -

- -
-
public struct DexAddCalculationResult  
-
-
-

A struct to hold all the necessary calculations for adding liquidity to a dex contract

- -
- -
-

Initializers

- -
-

- init(expected​Liquidity:​minimum​Liquidity:​token​Required:​exchange​Rate:​) -

-
-
public init(expectedLiquidity: TokenAmount, minimumLiquidity: TokenAmount, tokenRequired: TokenAmount, exchangeRate: Decimal)  
-
-
-
-
-

Properties

- -
-

- expected​Liquidity -

-
-
public let expectedLiquidity: TokenAmount
-
-
-
-

- minimum​Liquidity -

-
-
public let minimumLiquidity: TokenAmount
-
-
-
-

- token​Required -

-
-
public let tokenRequired: TokenAmount
-
-
-
-

- exchange​Rate -

-
-
public let exchangeRate: Decimal
-
-
-
- - - -
-
- - - - diff --git a/DexCalculationService/index.html b/DexCalculationService/index.html deleted file mode 100644 index af257db5..00000000 --- a/DexCalculationService/index.html +++ /dev/null @@ -1,1267 +0,0 @@ - - - - - - KukaiCoreSwift - DexCalculationService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Dex​Calculation​Service -

- -
-
public class DexCalculationService  
-
-
-

Wrapper around the kukai-dex-calculations JS library for performing calculations: https://github.com/kukai-wallet/kukai-dex-calculations

- -
- -
-

Properties

- -
-

- shared -

-
-
public static let shared  
-
-
-

Public shared instace to avoid having multiple copies of the underlying JSContext created

- -
-
-
-
-

Methods

- -
-

- calculate​Xtz​ToToken(xtz​ToSell:​xtz​Pool:​token​Pool:​max​Slippage:​dex:​) -

-
-
public func calculateXtzToToken(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexSwapCalculationResult?  
-
-
-

A helper function to create all the necessary calculations for a xtzToToken exchange, to perform the operation and display the info to the user in a confirmation screen.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
xtz​ToSellXTZAmount

The XTZAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex contract holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex contract holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
max​SlippageDouble

Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

-
-

Returns

-

DexSwapCalculationResult containing the results of all the necessary calculations.

- -
-
-

- calculate​Token​ToXTZ(token​ToSell:​xtz​Pool:​token​Pool:​max​Slippage:​dex:​) -

-
-
public func calculateTokenToXTZ(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexSwapCalculationResult?  
-
-
-

A helper function to create all the necessary calculations for a tokenToXtz exchange, to perform the operation and display the info to the user in a confirmation screen.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
token​ToSellToken​Amount

The TokenAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex contract holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex contract holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
max​SlippageDouble

Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

-
-

Returns

-

DexSwapCalculationResult containing the results of all the necessary calculations.

- -
-
-

- calculate​Add​Liquidity(xtz:​xtz​Pool:​token​Pool:​total​Liquidity:​max​Slippage:​dex:​) -

-
-
public func calculateAddLiquidity(xtz: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, totalLiquidity: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexAddCalculationResult?  
-
-
-

A helper function to create all the necessary calculations for adding liquidity, with an XTZ input

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
xtzXTZAmount

The amount of XTZ to deposit

-
xtz​PoolXTZAmount

The total XTZ held in the dex contract

-
token​PoolToken​Amount

The total token held in the dex contract

-
total​LiquidityToken​Amount

The ttotal liquidity held in the liquidity contract

-
max​SlippageDouble

Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

-
-

Returns

-

(tokenRequired: TokenAmount, liquidity: TokenAmount) containing the results of all the necessary calculations.

- -
-
-

- calculate​Add​Liquidity(token:​xtz​Pool:​token​Pool:​total​Liquidity:​max​Slippage:​dex:​) -

-
-
public func calculateAddLiquidity(token: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, totalLiquidity: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexAddCalculationResult?  
-
-
-

A helper function to create all the necessary calculations for adding liquidity, with an Token input

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tokenToken​Amount

The amount of Token to deposit

-
xtz​PoolXTZAmount

The total XTZ held in the dex contract

-
token​PoolToken​Amount

The total token held in the dex contract

-
total​LiquidityToken​Amount

The ttotal liquidity held in the liquidity contract

-
max​SlippageDouble

Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

-
-

Returns

-

(xtzRequired: XTZAmount, liquidity: TokenAmount) containing the results of all the necessary calculations.

- -
-
-

- calculate​Remove​Liquidity(liquidity​Burned:​total​Liquidity:​xtz​Pool:​token​Pool:​max​Slippage:​dex:​) -

-
-
public func calculateRemoveLiquidity(liquidityBurned: TokenAmount, totalLiquidity: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexRemoveCalculationResult?  
-
-
-

A helper function to create all the necessary calculations for removing liquidity, to return everything the user will get out

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
liquidity​BurnedToken​Amount

The amount of Liquidity tokens the user wants to burn or sell

-
total​LiquidityToken​Amount

The total volume of liquidity held in the contract

-
xtz​PoolXTZAmount

The xtz pool held in the dex contract

-
token​PoolToken​Amount

The token pool held in the dex contract

-
max​SlippageDouble

Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

-
-

Returns

-

(xtz: XTZAmount, token: TokenAmount) containing the results of all the necessary calculations.

- -
-
-

- settings(for​Dex:​) -

-
-
public static func settings(forDex dex: DipDupExchangeName) -> (fee: Double, burn: Double, includeSubsidy: Bool)  
-
-
-
-

- xtz​ToToken​Expected​Return(xtz​ToSell:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func xtzToTokenExpectedReturn(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> TokenAmount?  
-
-
-

The TokenAmount expected to be returned for the supplied XTZAmount, given the dex contract xtzPool and tokenPool.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
xtz​ToSellXTZAmount

The XTZAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

TokenAmount containing the amount the user can expect in return for their XTZ

- -
-
-

- xtz​ToToken​Minimum​Return(token​Amount:​slippage:​) -

-
-
public func xtzToTokenMinimumReturn(tokenAmount: TokenAmount, slippage: Double) -> TokenAmount?  
-
-
-

The minimum possible TokenAmount returned, taking into account slippage.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
token​AmountToken​Amount

The TokenAmount returned from xtzToTokenExpectedReturn().

-
slippageDouble

A double value between 0 and 1, indicating the maximum percentage of slippage a user will accept.

-
-

Returns

-

TokenAmount containing the minimum amount the user can expect in return for their XTZ

- -
-
-

- xtz​ToToken​Required​Xtz​For(token​Amount:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func xtzToTokenRequiredXtzFor(tokenAmount: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> XTZAmount?  
-
-
-

Calculate the XTZAmount required in order to receive the supplied TokenAmount.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
token​AmountToken​Amount

The TokenAmount the user wants to receive.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

XTZAmount containing the amount of XTZ required in order to recieve the amount of token.

- -
-
-

- xtz​ToToken​Exchange​Rate(xtz​ToSell:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func xtzToTokenExchangeRate(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?  
-
-
-

The exchange rate for a given trade, taking into account slippage and fees

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
xtz​ToSellXTZAmount

The XTZAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

Decimal containing the exchange rate from 1 XTZ to the requested Token

- -
-
-

- xtz​ToToken​Exchange​Rate​Display(xtz​ToSell:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func xtzToTokenExchangeRateDisplay(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?  
-
-
-

The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
xtz​ToSellXTZAmount

The XTZAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

Decimal containing the exchange rate from 1 XTZ to the requested Token

- -
-
-

- xtz​ToToken​Market​Rate(xtz​Pool:​token​Pool:​) -

-
-
public func xtzToTokenMarketRate(xtzPool: XTZAmount, tokenPool: TokenAmount) -> Decimal?  
-
-
-

Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

Decimal containing the exchange rate from 1 XTZ to the requested Token

- -
-
-

- xtz​ToToken​Price​Impact(xtz​ToSell:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func xtzToTokenPriceImpact(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?  
-
-
-

Calcualte the percentage the price impact the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
xtz​ToSellXTZAmount

The XTZAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

Decimal containing the slippage percentage, 0 - 100.

- -
-
-

- token​ToXtz​Expected​Return(token​ToSell:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func tokenToXtzExpectedReturn(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> XTZAmount?  
-
-
-

The XTZAmount expected to be returned for the supplied TokenAmount, given the dex contracts xtzPool and tokenPool.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
token​ToSellToken​Amount

The TokenAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

XTZAmount containing the amount the user can expect in return for their Token

- -
-
-

- token​ToXtz​Minimum​Return(xtz​Amount:​slippage:​) -

-
-
public func tokenToXtzMinimumReturn(xtzAmount: XTZAmount, slippage: Double) -> XTZAmount?  
-
-
-

The minimum possible XTZAmount returned, taking into account slippage.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
xtz​AmountXTZAmount

The XTZAmount returned from tokenToXtzExpectedReturn().

-
slippageDouble

A double value between 0 and 1, indicating the maximum percentage of slippage a user will accept.

-
-

Returns

-

XTZAmount containing the minimum amount the user can expect in return for their Token

- -
-
-

- token​ToXtz​Required​Token​For(xtz​Amount:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func tokenToXtzRequiredTokenFor(xtzAmount: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> TokenAmount?  
-
-
-

Calculate the TokenAmount required in order to receive the supplied XTZAmount.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
xtz​AmountXTZAmount

The XTZAmount the user wants to receive.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

TokenAmount containing the amount of Token required in order to recieve the amount of XTZ.

- -
-
-

- token​ToXtz​Exchange​Rate(token​ToSell:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func tokenToXtzExchangeRate(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?  
-
-
-

The exchange rate for a given trade, taking into account slippage and fees

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
token​ToSellToken​Amount

The TokenAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

Decimal containing the exchange rate from 1 of the given Token to XTZ

- -
-
-

- token​ToXtz​Exchange​Rate​Display(token​ToSell:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func tokenToXtzExchangeRateDisplay(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?  
-
-
-

The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
token​ToSellToken​Amount

The TokenAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

Decimal containing the exchange rate from 1 of the given Token to XTZ

- -
-
-

- token​ToXtz​Market​Rate(xtz​Pool:​token​Pool:​) -

-
-
public func tokenToXtzMarketRate(xtzPool: XTZAmount, tokenPool: TokenAmount) -> Decimal?  
-
-
-

Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

Decimal containing the exchange rate from 1 of the given Token to XTZ

- -
-
-

- token​ToXtz​Price​Impact(token​ToSell:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func tokenToXtzPriceImpact(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?  
-
-
-

Calcualte the percentage slippage the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
token​ToSellToken​Amount

The TokenAmount to sell.

-
xtz​PoolXTZAmount

The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

-
token​PoolToken​Amount

The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

-
-

Returns

-

Decimal containing the slippage percentage, 0 - 100.

- -
-
-

- add​Liquidity​Return(xtz​ToDeposit:​xtz​Pool:​total​Liquidity:​slippage:​dex:​) -

-
-
public func addLiquidityReturn(xtzToDeposit: XTZAmount, xtzPool: XTZAmount, totalLiquidity: TokenAmount, slippage: Double, dex: DipDupExchangeName) -> (expected: TokenAmount, minimum: TokenAmount)?  
-
-
-

Calculate the amount of liquidity tokens a user can expect back for an amount of XTZ and Token

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
xtz​ToDepositXTZAmount

The XTZ to send to the dex contract

-
token​ToDeposit

The Token to send to the dex contract

-
total​LiquidityToken​Amount

The total liquidity already in the contract

-
slippageDouble

Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

-
-

Returns

-

TokenAmount an amount of Liquidity token you will receive

- -
-
-

- add​Liquidity​Token​Required(xtz​ToDeposit:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func addLiquidityTokenRequired(xtzToDeposit: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> TokenAmount?  
-
-
-

Calculate the amount of Token that is required to send along side your XTZ

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
xtz​ToDepositXTZAmount

The amount of XTZ to send

-
xtz​PoolXTZAmount

The XTZ currently held in the dex contract

-
token​PoolToken​Amount

The Token currently held in the dex contract

-
-

Returns

-

TokenAmount The amount of token required to send with the given amount of XTZ

- -
-
-

- add​Liquidity​Xtz​Required(token​ToDeposit:​xtz​Pool:​token​Pool:​dex:​) -

-
-
public func addLiquidityXtzRequired(tokenToDeposit: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> XTZAmount?  
-
-
-

Calculate the amount of XTZ that is required to send along side your Token

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
token​ToDepositToken​Amount

The amount of Token to send

-
xtz​PoolXTZAmount

The XTZ currently held in the dex contract

-
token​PoolToken​Amount

The Token currently held in the dex contract

-
-

Returns

-

XTZAmount The amount of XTZ required to send with the given amount of Token

- -
-
-

- remove​Liquidity​Token​Received(liquidity​Burned:​total​Liquidity:​token​Pool:​slippage:​) -

-
-
public func removeLiquidityTokenReceived(liquidityBurned: TokenAmount, totalLiquidity: TokenAmount, tokenPool: TokenAmount, slippage: Double) -> (expected: TokenAmount, minimum: TokenAmount)?  
-
-
-

Calculate the amount of token a user would revice back if they burned X liquidity

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
liquidity​BurnedToken​Amount

The amount of liquidity to burn

-
total​LiquidityToken​Amount

The totla liquidity held in the dex contract

-
token​PoolToken​Amount

The total token held in the dex contract

-
slippageDouble

Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

-
-

Returns

-

TokenAmount The amount of Token that would be returned

- -
-
-

- remove​Liquidity​Xtz​Received(liquidity​Burned:​total​Liquidity:​xtz​Pool:​slippage:​dex:​) -

-
-
public func removeLiquidityXtzReceived(liquidityBurned: TokenAmount, totalLiquidity: TokenAmount, xtzPool: XTZAmount, slippage: Double, dex: DipDupExchangeName) -> (expected: XTZAmount, minimum: XTZAmount)?  
-
-
-

Calculate the amount of XTZ a user would revice back if they burned X liquidity

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
liquidity​BurnedToken​Amount

The amount of liquidity to burn

-
total​LiquidityToken​Amount

The totla liquidity held in the dex contract

-
xtz​PoolXTZAmount

The total XTZ held in the dex contract

-
slippageDouble

Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

-
-

Returns

-

XTZAmount The amount of XTZ that would be returned

- -
-
-

- estimate​Liquidity​Baking​APY(xtz​Pool:​) -

-
-
public func estimateLiquidityBakingAPY(xtzPool: XTZAmount) -> Decimal?  
-
-
-

Estimate the APY of liquidity baking contract, as it has a known income.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
xtz​PoolXTZAmount

The total XTZ held in the dex contract

-
-

Returns

-

Decimal The estimated percentage APY

- -
-
- - - -
-
- - - - diff --git a/DexRemoveCalculationResult/index.html b/DexRemoveCalculationResult/index.html deleted file mode 100644 index 0b36f23a..00000000 --- a/DexRemoveCalculationResult/index.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - KukaiCoreSwift - DexRemoveCalculationResult - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dex​Remove​Calculation​Result -

- -
-
public struct DexRemoveCalculationResult  
-
-
-

A struct to hold all the necessary calculations for removing liquidity from a dex contract

- -
- -
-

Initializers

- -
-

- init(expected​XTZ:​minimum​XTZ:​expected​Token:​minimum​Token:​exchange​Rate:​) -

-
-
public init(expectedXTZ: XTZAmount, minimumXTZ: XTZAmount, expectedToken: TokenAmount, minimumToken: TokenAmount, exchangeRate: Decimal)  
-
-
-
-
-

Properties

- -
-

- expected​XTZ -

-
-
public let expectedXTZ: XTZAmount
-
-
-
-

- minimum​XTZ -

-
-
public let minimumXTZ: XTZAmount
-
-
-
-

- expected​Token -

-
-
public let expectedToken: TokenAmount
-
-
-
-

- minimum​Token -

-
-
public let minimumToken: TokenAmount
-
-
-
-

- exchange​Rate -

-
-
public let exchangeRate: Decimal
-
-
-
- - - -
-
- - - - diff --git a/DexSwapCalculationResult/index.html b/DexSwapCalculationResult/index.html deleted file mode 100644 index 71b8f5f8..00000000 --- a/DexSwapCalculationResult/index.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - KukaiCoreSwift - DexSwapCalculationResult - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dex​Swap​Calculation​Result -

- -
-
public struct DexSwapCalculationResult  
-
-
-

A struct to hold all the necessary calculations for a dex trade

- -
- -
-

Initializers

- -
-

- init(expected:​minimum:​display​Exchange​Rate:​display​Price​Impact:​) -

-
-
public init(expected: TokenAmount, minimum: TokenAmount, displayExchangeRate: Decimal, displayPriceImpact: Double)  
-
-
-
-
-

Properties

- -
-

- expected -

-
-
public let expected: TokenAmount
-
-
-
-

- minimum -

-
-
public let minimum: TokenAmount
-
-
-
-

- display​Exchange​Rate -

-
-
public let displayExchangeRate: Decimal
-
-
-
-

- display​Price​Impact -

-
-
public let displayPriceImpact: Double
-
-
-
- - - -
-
- - - - diff --git a/Dictionary/index.html b/Dictionary/index.html deleted file mode 100644 index ca05a4da..00000000 --- a/Dictionary/index.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - KukaiCoreSwift - Dictionary - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - Dictionary -

-
-

Methods

- -
-

- michelson​Value() -

-
-
func michelsonValue() -> [String: Any]?  
-
-
-
-

- michelson​Value​Array() -

-
-
func michelsonValueArray() -> [[String: Any]]?  
-
-
-
-

- michelson​Args​Array() -

-
-
func michelsonArgsArray() -> [[String: Any]]?  
-
-
-
-

- michelson​Args​Unknown​Array() -

-
-
func michelsonArgsUnknownArray() -> [Any]?  
-
-
-
-

- michelson​Int() -

-
-
func michelsonInt() -> String?  
-
-
-
-

- michelson​String() -

-
-
func michelsonString() -> String?  
-
-
-
-
-
- - - - diff --git a/DipDupChartData/index.html b/DipDupChartData/index.html deleted file mode 100644 index 91335b66..00000000 --- a/DipDupChartData/index.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupChartData - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dip​Dup​Chart​Data -

- -
-
public struct DipDupChartData: Codable  
-
-
-

Struct to hold 4 arrays of data, each one mapping to a different timeline of data, to allow the display of graphs

- -
-
- -
- - - - - - -%789 - - - -DipDupChartData - - -DipDupChartData - - - - - -Codable - -Codable - - - -DipDupChartData->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- quotes15mNogaps -

-
-
public let quotes15mNogaps: [DipDupChartObject] 
-
-
-

Contains the last 24 hours of data at 15 min intervals

- -
-
-
-

- quotes1hNogaps -

-
-
public let quotes1hNogaps: [DipDupChartObject] 
-
-
-

Contains every hour for past 7 days

- -
-
-
-

- quotes1dNogaps -

-
-
public let quotes1dNogaps: [DipDupChartObject] 
-
-
-

Contains every day for 30 days

- -
-
-
-

- quotes1wNogaps -

-
-
public let quotes1wNogaps: [DipDupChartObject] 
-
-
-

Contains every week for 52 weeks

- -
-
-
- - - -
-
- - - - diff --git a/DipDupChartObject/index.html b/DipDupChartObject/index.html deleted file mode 100644 index d622c458..00000000 --- a/DipDupChartObject/index.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupChartObject - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dip​Dup​Chart​Object -

- -
-
public struct DipDupChartObject: Codable  
-
-
-

Structure holding a data slice

- -
-
- -
- - - - - - -%7 - - - -DipDupChartObject - - -DipDupChartObject - - - - - -Codable - -Codable - - - -DipDupChartObject->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- average -

-
-
public let average: Decimal
-
-
-

The average price at the given time

- -
-
-
-

- exchange​Id -

-
-
public let exchangeId: String
-
-
-

The address of the contract

- -
-
-
-

- bucket -

-
-
public let bucket: String
-
-
-

String representing the date and time the slice is for

- -
-
-
-

- high -

-
-
public let high: String
-
-
-

The highest value reached in this slice

- -
-
-
-

- low -

-
-
public let low: String
-
-
-

The lowest value reached in this slice

- -
-
-
-
-

Methods

- -
-

- date() -

-
-
public func date() -> Date?  
-
-
-

Convert the bucket string into a Date object

- -
-
-
-

- average​Double() -

-
-
public func averageDouble() -> Double  
-
-
-

Convert the average value into a Double

- -
-
-
-

- high​Double() -

-
-
public func highDouble() -> Double  
-
-
-

Convert the high value into a Double

- -
-
-
-

- low​Double() -

-
-
public func lowDouble() -> Double  
-
-
-

Convert the low value into a Double

- -
-
-
- - - -
-
- - - - diff --git a/DipDupClient/index.html b/DipDupClient/index.html deleted file mode 100644 index a2ac3225..00000000 --- a/DipDupClient/index.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupClient - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Dip​Dup​Client -

- -
-
public class DipDupClient  
-
-
-

This client exposes functions to allow communication to the indexer platform DipDup ( https://dipdup.net/ ). -DipDup is composed of many small, dedicated indexers, powered by GraphQL. This client tries to exposes userflow functions, allowing users to accomplish tasks without having to worry about the underlying complexities

- -
- -
-

Initializers

- -
-

- init(network​Service:​config:​) -

-
-
public init(networkService: NetworkService, config: TezosNodeClientConfig)  
-
-
-

Init a DipDupClient with a NetworkService and a TezosNodeClientConfig.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
network​ServiceNetwork​Service

NetworkService used to manage network communication.

-
configTezos​Node​Client​Config

TezosNodeClientConfig used to apss in settings.

-
-
-
-
-

Properties

- -
-

- dex​Max​Query​Size -

-
-
public static let dexMaxQuerySize = 100
-
-
-

Max enteries to return per request

- -
-
-
-
-

Methods

- -
-

- get​Exchanges​And​Tokens(limit:​offset:​completion:​) -

-
-
public func getExchangesAndTokens(limit: Int = DipDupClient.dexMaxQuerySize, offset: Int = 0, completion: @escaping ((Result<GraphQLResponse<DipDupExchangesAndTokensResponse>, KukaiError>) -> Void))  
-
-
-

Get a list of all the tokens available and on what excahnges (including their prices and pool data)

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
limitInt

Int, How many results to reuturn 100 Max)

-
offsetInt

Int, How many positions to move the cursor

-
completion@escaping ((Result<Graph​QLResponse<Dip​Dup​Exchanges​And​Tokens​Response>, Kukai​Error>) -> Void)

Block returning a GraphQL response or an KukaiError

-
-
-
-

- get​All​Exchanges​And​Tokens(completion:​) -

-
-
public func getAllExchangesAndTokens(completion: @escaping ((Result<[DipDupExchangesAndTokens], KukaiError>) -> Void))  
-
-
-

Recurrsively call getExchangesAndTokens(...) until we have found all the tokens

- -
-

Parameters

- - - - - - - - - - - - - - - - -
completion@escaping ((Result<[Dip​Dup​Exchanges​And​Tokens], Kukai​Error>) -> Void)

Block returning a GraphQL response or an KukaiError

-
-
-
-

- get​Liquidity​For(address:​completion:​) -

-
-
public func getLiquidityFor(address: String, completion: @escaping ((Result<GraphQLResponse<DipDupPosition>, KukaiError>) -> Void))  
-
-
-

Query a given addresses liquidity token balances

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
addressString

The TZ address to query for

-
completion@escaping ((Result<Graph​QLResponse<Dip​Dup​Position>, Kukai​Error>) -> Void)

Block returning a GraphQL response or an KukaiError

-
-
-
-

- get​Chart​Data​For(exchange​Contract:​now​Date:​completion:​) -

-
-
public func getChartDataFor(exchangeContract: String, nowDate: Date = Date(), completion: @escaping ((Result<GraphQLResponse<DipDupChartData>, KukaiError>) -> Void))  
-
-
-

Query a given contract address for pricing data for the given token

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
exchange​ContractString

The KT address of the dex contract to query data for

-
completion@escaping ((Result<Graph​QLResponse<Dip​Dup​Chart​Data>, Kukai​Error>) -> Void)

Block returning a GraphQL response or an KukaiError

-
-
-
- - - -
-
- - - - diff --git a/DipDupExchange/index.html b/DipDupExchange/index.html deleted file mode 100644 index a2b7d20c..00000000 --- a/DipDupExchange/index.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupExchange - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dip​Dup​Exchange -

- -
-
public struct DipDupExchange: Codable, Hashable, Equatable  
-
-
-

A DipDup Exchange object with all the necessary pieces for checking liquidity and performing Swaps

- -
-
- -
- - - - - - -%459 - - - -DipDupExchange - - -DipDupExchange - - - - - -Codable - -Codable - - - -DipDupExchange->Codable - - - - - -Equatable - -Equatable - - - -DipDupExchange->Equatable - - - - - -Hashable - -Hashable - - - -DipDupExchange->Hashable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Equatable
-
Hashable
-
-
-
-

Properties

- -
-

- name -

-
-
public let name: DipDupExchangeName
-
-
-

Enum to denote the type of Exchange (e.g. Liquidity Baking, Quipuswap)

- -
-
-
-

- address -

-
-
public let address: String
-
-
-

The KT address of the exchange contract

- -
-
-
-

- tez​Pool -

-
-
public let tezPool: String
-
-
-

String representation of the Exchanges TezPool

- -
-
-
-

- token​Pool -

-
-
public let tokenPool: String
-
-
-

String representation of the Exchanges TokenPool

- -
-
-
-

- shares​Total -

-
-
public let sharesTotal: String
-
-
-

The total liquidity available (RPC representation, no decimals)

- -
-
-
-

- mid​Price -

-
-
public let midPrice: String
-
-
-

The daily middle price

- -
-
-
-

- token -

-
-
public let token: DipDupToken
-
-
-

The token object containing all the token info (decimals, contract address, symbol etc,)

- -
-
-
-
-

Methods

- -
-

- xtz​Pool​Amount() -

-
-
public func xtzPoolAmount() -> XTZAmount  
-
-
-

Return the XTZ pool as an XTZAmount object

- -
-
-
-

- token​Pool​Amount() -

-
-
public func tokenPoolAmount() -> TokenAmount  
-
-
-

Return the Token pool as an TokenAmount object

- -
-
-
-

- liquidity​Token​Decimal​Places() -

-
-
public func liquidityTokenDecimalPlaces() -> Int  
-
-
-

Retrieving the liquidity token decimals is currently not supported. Hardcode the numbers for now

- -
-
-
-

- total​Liquidity() -

-
-
public func totalLiquidity() -> TokenAmount  
-
-
-

Return the total liquidity as an TokenAmount object

- -
-
-
-

- are​Pools​Empty() -

-
-
public func arePoolsEmpty() -> Bool  
-
-
-

Helper to detect if the pools are empty (determiens if the next addLiquidity will be setting the exchange rate)

- -
-
-
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-

Conforming to Hashable to enable working with UITableViewDiffableDataSource

- -
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: DipDupExchange, rhs: DipDupExchange) -> Bool  
-
-
-

Conforming to Equatable to enable working with UITableViewDiffableDataSource

- -
-
-
- - - -
-
- - - - diff --git a/DipDupExchangeName/index.html b/DipDupExchangeName/index.html deleted file mode 100644 index 8054a1ef..00000000 --- a/DipDupExchangeName/index.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupExchangeName - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Dip​Dup​Exchange​Name -

- -
-
public enum DipDupExchangeName: String, Codable  
-
-
-

Enum to wrap up the available types of Exchange on DipDup

- -
-
- -
- - - - - - -%661 - - - -DipDupExchangeName - - -DipDupExchangeName - - - - - -String - -String - - - -DipDupExchangeName->String - - - - - -Codable - -Codable - - - -DipDupExchangeName->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Initializers

- -
-

- init(from:​) -

-
-
public init(from decoder: Decoder) throws  
-
-
-
-
-

Enumeration Cases

- -
-

- quipuswap -

-
-
case quipuswap
-
-
-
-

- lb -

-
-
case lb
-
-
-
-

- unknown -

-
-
case unknown
-
-
-
- - - -
-
- - - - diff --git a/DipDupExchangesAndTokens/index.html b/DipDupExchangesAndTokens/index.html deleted file mode 100644 index 10a5b702..00000000 --- a/DipDupExchangesAndTokens/index.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupExchangesAndTokens - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dip​Dup​Exchanges​And​Tokens -

- -
-
public struct DipDupExchangesAndTokens: Codable  
-
-
-

Wrapper object to map to network response type

- -
-
- -
- - - - - - -%367 - - - -DipDupExchangesAndTokens - - -DipDupExchangesAndTokens - - - - - -Codable - -Codable - - - -DipDupExchangesAndTokens->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- symbol -

-
-
public let symbol: String
-
-
-
-

- address -

-
-
public let address: String
-
-
-
-

- token​Id -

-
-
public let tokenId: Decimal
-
-
-
-

- exchanges -

-
-
public let exchanges: [DipDupExchange] 
-
-
-
-
-

Methods

- -
-

- total​Exchange​Xtz​Pool() -

-
-
public func totalExchangeXtzPool() -> XTZAmount  
-
-
-

Get the total XTZ pool amount from all the exchanges, useful for sorting

- -
-
-
- - - -
-
- - - - diff --git a/DipDupExchangesAndTokensResponse/index.html b/DipDupExchangesAndTokensResponse/index.html deleted file mode 100644 index 150aaa1f..00000000 --- a/DipDupExchangesAndTokensResponse/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupExchangesAndTokensResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dip​Dup​Exchanges​And​Tokens​Response -

- -
-
public struct DipDupExchangesAndTokensResponse: Codable  
-
-
-

Wrapper object to map to network response type

- -
-
- -
- - - - - - -%3 - - - -DipDupExchangesAndTokensResponse - - -DipDupExchangesAndTokensResponse - - - - - -Codable - -Codable - - - -DipDupExchangesAndTokensResponse->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- token -

-
-
public let token: [DipDupExchangesAndTokens] 
-
-
-
- - - -
-
- - - - diff --git a/DipDupPosition/index.html b/DipDupPosition/index.html deleted file mode 100644 index bf175161..00000000 --- a/DipDupPosition/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupPosition - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dip​Dup​Position -

- -
-
public struct DipDupPosition: Codable  
-
-
-

Wrapper object to match network response type

- -
-
- -
- - - - - - -%55 - - - -DipDupPosition - - -DipDupPosition - - - - - -Codable - -Codable - - - -DipDupPosition->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- position -

-
-
public let position: [DipDupPositionData] 
-
-
-
- - - -
-
- - - - diff --git a/DipDupPositionData/index.html b/DipDupPositionData/index.html deleted file mode 100644 index d9f7cc4b..00000000 --- a/DipDupPositionData/index.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupPositionData - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dip​Dup​Position​Data -

- -
-
public struct DipDupPositionData: Codable, Hashable, Equatable  
-
-
-

A position on DipDup corresponds to liquidity token ownership. Each of these objects represents an amount of Liquidity tokens in an exchange for the given address

- -
-
- -
- - - - - - -%591 - - - -DipDupPositionData - - -DipDupPositionData - - - - - -Equatable - -Equatable - - - -DipDupPositionData->Equatable - - - - - -Codable - -Codable - - - -DipDupPositionData->Codable - - - - - -Hashable - -Hashable - - - -DipDupPositionData->Hashable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Equatable
-
Hashable
-
-
-
-

Properties

- -
-

- shares​Qty -

-
-
public let sharesQty: String
-
-
-

The liquidity token balance (rpc representation)

- -
-
-
-

- exchange -

-
-
public let exchange: DipDupExchange
-
-
-

The exchange the token belongs too

- -
-
-
-
-

Methods

- -
-

- token​Amount() -

-
-
public func tokenAmount() -> TokenAmount  
-
-
-

Convert the token data into a TokenAmount

- -
-
-
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-

Conforming to Hashable to enable working with UITableViewDiffableDataSource

- -
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: DipDupPositionData, rhs: DipDupPositionData) -> Bool  
-
-
-

Conforming to Equatable to enable working with UITableViewDiffableDataSource

- -
-
-
- - - -
-
- - - - diff --git a/DipDupToken/index.html b/DipDupToken/index.html deleted file mode 100644 index 05279b0d..00000000 --- a/DipDupToken/index.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupToken - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Dip​Dup​Token -

- -
-
public struct DipDupToken: Codable, Hashable, Equatable  
-
-
-

DipDup representation of a Token

- -
-
- -
- - - - - - -%247 - - - -DipDupToken - - -DipDupToken - - - - - -Hashable - -Hashable - - - -DipDupToken->Hashable - - - - - -Codable - -Codable - - - -DipDupToken->Codable - - - - - -Equatable - -Equatable - - - -DipDupToken->Equatable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Equatable
-
Hashable
-
-
-
-

Properties

- -
-

- symbol -

-
-
public let symbol: String
-
-
-

The user facing symbol of the token

- -
-
-
-

- address -

-
-
public let address: String
-
-
-

The TZ address of the token

- -
-
-
-

- token​Id -

-
-
public let tokenId: Decimal
-
-
-

The token ID of the token (always 0 for FA1.2 tokens)

- -
-
-
-

- decimals -

-
-
public let decimals: Int
-
-
-

The number of decimals for the token

- -
-
-
-

- standard -

-
-
public let standard: DipDupTokenStandard
-
-
-

Which standard the token follows

- -
-
-
-
-

Methods

- -
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-

Conforming to Hashable to enable working with UITableViewDiffableDataSource

- -
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: DipDupToken, rhs: DipDupToken) -> Bool  
-
-
-

Conforming to Equatable to enable working with UITableViewDiffableDataSource

- -
-
-
- - - -
-
- - - - diff --git a/DipDupTokenStandard/index.html b/DipDupTokenStandard/index.html deleted file mode 100644 index 26b0e45a..00000000 --- a/DipDupTokenStandard/index.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - KukaiCoreSwift - DipDupTokenStandard - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Dip​Dup​Token​Standard -

- -
-
public enum DipDupTokenStandard: String, Codable  
-
-
-

Wrapping up the FA standards into an enum

- -
-
- -
- - - - - - -%737 - - - -DipDupTokenStandard - - -DipDupTokenStandard - - - - - -String - -String - - - -DipDupTokenStandard->String - - - - - -Codable - -Codable - - - -DipDupTokenStandard->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Initializers

- -
-

- init(from:​) -

-
-
public init(from decoder: Decoder) throws  
-
-
-
-
-

Enumeration Cases

- -
-

- fa12 -

-
-
case fa12
-
-
-
-

- fa2 -

-
-
case fa2
-
-
-
-

- unknown -

-
-
case unknown
-
-
-
- - - -
-
- - - - diff --git a/DiskService/index.html b/DiskService/index.html deleted file mode 100644 index 51db74bb..00000000 --- a/DiskService/index.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - KukaiCoreSwift - DiskService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Disk​Service -

- -
-
public class DiskService  
-
-
-

A service class to write and read data from the devices documents directory

- -
- -
-

Methods

- -
-

- write(data:​to​File​Name:​) -

-
-
public static func write(data: Data, toFileName: String) -> Bool  
-
-
-

Write an instance of Data to a given fileName

- -
-

Returns

-

Bool, indicating if the operation was successful

- -
-
-

- write(encodable:​to​File​Name:​) -

-
-
public static func write<T: Encodable>(encodable: T, toFileName: String) -> Bool  
-
-
-

Write an instance of an object conforming to Encodable to a fileName

- -
-

Returns

-

Bool, indicating if the operation was successful

- -
-
-

- read​Data(from​File​Name:​) -

-
-
public static func readData(fromFileName: String) -> Data?  
-
-
-

Read a fileName and return the contents as Data

- -
-

Returns

-

Data, if able to read file

- -
-
-

- read(type:​from​File​Name:​) -

-
-
public static func read<T: Decodable>(type: T.Type, fromFileName: String) -> T?  
-
-
-

Read a fileName, and parse the contents as an instance of a Decodable object

- -
-

Returns

-

An instance of the Decodable type, if able to read file and parse it

- -
-
-

- delete(file​Name:​) -

-
-
public static func delete(fileName: String) -> Bool  
-
-
-

Delete a fileName

- -
-

Returns

-

Bool, indicating if the operation was successful

- -
-
-

- delete(file​Names:​) -

-
-
public static func delete(fileNames: [String]) -> Bool  
-
-
-
-

- documents​Directory() -

-
-
public static func documentsDirectory() -> URL?  
-
-
-

Get the URL to the devices documents directory, if possible

- -
-
-
-

- exists(file​Name:​) -

-
-
public static func exists(fileName: String) -> URL?  
-
-
-

Check if a fileName exists in the documents directory or not

- -
-
-
-

- all​File​Names​With(prefix:​) -

-
-
public static func allFileNamesWith(prefix: String) -> [String]  
-
-
-

Find all files in documents directory begining with prefix

- -
-
-
- - - -
-
- - - - diff --git a/Enums.html b/Enums.html new file mode 100644 index 00000000..6c91ec6b --- /dev/null +++ b/Enums.html @@ -0,0 +1,1313 @@ + + + + Enumerations Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Enumerations

+

The following enumerations are available globally.

+ +
+
+
+
    +
  • +
    + + + + ResultExtensionError + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum ResultExtensionError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupExchangeName + +
    +
    +
    +
    +
    +
    +

    Enum to wrap up the available types of Exchange on DipDup

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum DipDupExchangeName : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupTokenStandard + +
    +
    +
    +
    +
    +
    +

    Wrapping up the FA standards into an enum

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum DipDupTokenStandard : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBakerHealth + +
    +
    +
    +
    +
    +
    +

    The stability of the bakers server

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TzKTBakerHealth : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBakerAccuracy + +
    +
    +
    +
    +
    +
    +

    The accuracy of the bakers payments

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TzKTBakerAccuracy : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBakerTiming + +
    +
    +
    +
    +
    +
    +

    The reliability of the bakers payouts

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TzKTBakerTiming : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + BiometricType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum BiometricType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CurrentDevice + +
    +
    +
    +
    +
    +
    +

    Enum used to get details about the current device’s capabilities

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum CurrentDevice
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + HDWalletError + +
    +
    +
    +
    +
    +
    +

    Error types that can be passed by failable inits

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum HDWalletError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationKind + +
    +
    +
    +
    +
    +
    +

    Enum representing the various kinds of supported Operation‘s

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum OperationKind : String, Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum OperationTransactionError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FaVersion + +
    +
    +
    +
    +
    +
    +

    Enum representing the version of tezos “FA” token contracts

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum FaVersion : String, Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Enums +

+
+
+
    +
  • +
    + + + + WalletType + +
    +
    +
    +
    +
    +
    +

    Enum to distingush between linear (non-hd) wallets, using the Bip39 standard, and hd wallets using the Bip44 standard.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum WalletType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + WalletError + +
    +
    +
    +
    +
    +
    +

    Possible error types that can occur when using the LedgerWallet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum WalletError : Error
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum MediaProxyServiceError : String, Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CacheType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum CacheType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DAppCategory + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum DAppCategory
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DAppAccessType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum DAppAccessType
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + TorusAuthProvider + +
    +
    +
    +
    +
    +
    +

    List of providers currently supported and available on the Tezos network

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TorusAuthProvider : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TorusAuthError + +
    +
    +
    +
    +
    +
    +

    Custom TorusAuthService errors that cna be thrown

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TorusAuthError : Error
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/BiometricType.html b/Enums/BiometricType.html new file mode 100644 index 00000000..ccd1c9b2 --- /dev/null +++ b/Enums/BiometricType.html @@ -0,0 +1,844 @@ + + + + BiometricType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BiometricType

+
+
+ +
public enum BiometricType
+ +
+
+ +
+
+
+
    +
  • +
    + + + + unavailable + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unavailable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case none
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + touchID + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case touchID
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + faceID + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case faceID
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/CacheType.html b/Enums/CacheType.html new file mode 100644 index 00000000..4d74642f --- /dev/null +++ b/Enums/CacheType.html @@ -0,0 +1,792 @@ + + + + CacheType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

CacheType

+
+
+ +
public enum CacheType
+ +
+
+ +
+
+
+
    +
  • +
    + + + + temporary + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case temporary
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + permanent + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case permanent
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/CurrentDevice.html b/Enums/CurrentDevice.html new file mode 100644 index 00000000..f6b100f4 --- /dev/null +++ b/Enums/CurrentDevice.html @@ -0,0 +1,820 @@ + + + + CurrentDevice Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

CurrentDevice

+
+
+ +
public enum CurrentDevice
+ +
+
+

Enum used to get details about the current device’s capabilities

+ +
+
+
+
    +
  • +
    + + + + isSimulator + +
    +
    +
    +
    +
    +
    +

    Is the current device a simulator

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static var isSimulator: Bool { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func biometricTypeAuthorized() -> BiometricType
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func biometricTypeSupported() -> BiometricType
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/DAppAccessType.html b/Enums/DAppAccessType.html new file mode 100644 index 00000000..b6c63581 --- /dev/null +++ b/Enums/DAppAccessType.html @@ -0,0 +1,818 @@ + + + + DAppAccessType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DAppAccessType

+
+
+ +
public enum DAppAccessType
+ +
+
+ +
+
+
+
    +
  • +
    + + + + all + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case all
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + directAuthOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case directAuthOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case none
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/DAppCategory.html b/Enums/DAppCategory.html new file mode 100644 index 00000000..0ea315b9 --- /dev/null +++ b/Enums/DAppCategory.html @@ -0,0 +1,818 @@ + + + + DAppCategory Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DAppCategory

+
+
+ +
public enum DAppCategory
+ +
+
+ +
+
+
+
    +
  • +
    + + + + marketplace + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case marketplace
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchange + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case exchange
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + collectible + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case collectible
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/DipDupExchangeName.html b/Enums/DipDupExchangeName.html new file mode 100644 index 00000000..d8082c21 --- /dev/null +++ b/Enums/DipDupExchangeName.html @@ -0,0 +1,845 @@ + + + + DipDupExchangeName Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupExchangeName

+
+
+ +
public enum DipDupExchangeName : String, Codable
+ +
+
+

Enum to wrap up the available types of Exchange on DipDup

+ +
+
+
+
    +
  • +
    + + + + quipuswap + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case quipuswap
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lb + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case lb
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/DipDupTokenStandard.html b/Enums/DipDupTokenStandard.html new file mode 100644 index 00000000..39ab5321 --- /dev/null +++ b/Enums/DipDupTokenStandard.html @@ -0,0 +1,845 @@ + + + + DipDupTokenStandard Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupTokenStandard

+
+
+ +
public enum DipDupTokenStandard : String, Codable
+ +
+
+

Wrapping up the FA standards into an enum

+ +
+
+
+
    +
  • +
    + + + + fa12 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fa12
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fa2 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fa2
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/FaVersion.html b/Enums/FaVersion.html new file mode 100644 index 00000000..2cbb27d6 --- /dev/null +++ b/Enums/FaVersion.html @@ -0,0 +1,845 @@ + + + + FaVersion Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FaVersion

+
+
+ +
public enum FaVersion : String, Codable
+ +
+
+

Enum representing the version of tezos “FA” token contracts

+ +
+
+
+
    +
  • +
    + + + + fa1_2 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fa1_2 = "fa1.2"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fa2 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fa2
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/HDWalletError.html b/Enums/HDWalletError.html new file mode 100644 index 00000000..2e404c00 --- /dev/null +++ b/Enums/HDWalletError.html @@ -0,0 +1,767 @@ + + + + HDWalletError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

HDWalletError

+
+
+ +
public enum HDWalletError : Error
+ +
+
+

Error types that can be passed by failable inits

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidWalletCoreWallet
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/MediaProxyServiceError.html b/Enums/MediaProxyServiceError.html new file mode 100644 index 00000000..7f5877ab --- /dev/null +++ b/Enums/MediaProxyServiceError.html @@ -0,0 +1,792 @@ + + + + MediaProxyServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediaProxyServiceError

+
+
+ +
public enum MediaProxyServiceError : String, Error
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noMimeTypeFoundInsideFormats
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToParseContentType
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/OperationKind.html b/Enums/OperationKind.html new file mode 100644 index 00000000..ceb9da07 --- /dev/null +++ b/Enums/OperationKind.html @@ -0,0 +1,1145 @@ + + + + OperationKind Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationKind

+
+
+ +
public enum OperationKind : String, Codable
+ +
+
+

Enum representing the various kinds of supported Operation‘s

+ +
+
+
+
    +
  • +
    + + + + transaction + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case transaction
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reveal + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case reveal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case delegation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + origination + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case origination
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + activate_account + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case activate_account
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endorsement + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case endorsement
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + seed_nonce_revelation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case seed_nonce_revelation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case double_endorsement_evidence
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case double_baking_evidence
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proposals + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case proposals
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ballot + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ballot
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/OperationTransactionError.html b/Enums/OperationTransactionError.html new file mode 100644 index 00000000..2d00d890 --- /dev/null +++ b/Enums/OperationTransactionError.html @@ -0,0 +1,766 @@ + + + + OperationTransactionError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationTransactionError

+
+
+ +
public enum OperationTransactionError : Error
+ +
+
+ +
+
+
+
    +
  • +
    + + + + invalidMichelsonValue + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidMichelsonValue
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/ResultExtensionError.html b/Enums/ResultExtensionError.html new file mode 100644 index 00000000..50c80435 --- /dev/null +++ b/Enums/ResultExtensionError.html @@ -0,0 +1,766 @@ + + + + ResultExtensionError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ResultExtensionError

+
+
+ +
public enum ResultExtensionError : Error
+ +
+
+ +
+
+
+
    +
  • +
    + + + + noErrorFound + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noErrorFound
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/TorusAuthError.html b/Enums/TorusAuthError.html new file mode 100644 index 00000000..cc0de7d3 --- /dev/null +++ b/Enums/TorusAuthError.html @@ -0,0 +1,923 @@ + + + + TorusAuthError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TorusAuthError

+
+
+ +
public enum TorusAuthError : Error
+ +
+
+

Custom TorusAuthService errors that cna be thrown

+ +
+
+
+
    +
  • +
    + + + + missingVerifier + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case missingVerifier
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidTorusResponse + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidTorusResponse
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + cryptoError + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case cryptoError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidNodeDetails + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidNodeDetails
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidTwitterURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidTwitterURL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + noTwiiterUserIdFound + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noTwiiterUserIdFound
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidAppleResponse + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidAppleResponse
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/TorusAuthProvider.html b/Enums/TorusAuthProvider.html new file mode 100644 index 00000000..e5ac44c6 --- /dev/null +++ b/Enums/TorusAuthProvider.html @@ -0,0 +1,975 @@ + + + + TorusAuthProvider Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TorusAuthProvider

+
+
+ +
public enum TorusAuthProvider : String, Codable
+ +
+
+

List of providers currently supported and available on the Tezos network

+ +
+
+
+
    +
  • +
    + + + + apple + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case apple
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + google + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case google
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + facebook + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case facebook
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case twitter
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reddit + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case reddit
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + discord + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case discord
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitch + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case twitch
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + line + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case line
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + github + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case github
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/TzKTBakerAccuracy.html b/Enums/TzKTBakerAccuracy.html new file mode 100644 index 00000000..e52ad5e6 --- /dev/null +++ b/Enums/TzKTBakerAccuracy.html @@ -0,0 +1,845 @@ + + + + TzKTBakerAccuracy Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerAccuracy

+
+
+ +
public enum TzKTBakerAccuracy : String, Codable
+ +
+
+

The accuracy of the bakers payments

+ +
+
+
+
    +
  • +
    + + + + precise + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case precise
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + inaccurate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case inaccurate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + suspicious + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case suspicious
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + no_data + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case no_data
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/TzKTBakerHealth.html b/Enums/TzKTBakerHealth.html new file mode 100644 index 00000000..e55e5ea8 --- /dev/null +++ b/Enums/TzKTBakerHealth.html @@ -0,0 +1,819 @@ + + + + TzKTBakerHealth Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerHealth

+
+
+ +
public enum TzKTBakerHealth : String, Codable
+ +
+
+

The stability of the bakers server

+ +
+
+
+
    +
  • +
    + + + + active + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case active
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + closed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case closed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + dead + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case dead
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/TzKTBakerTiming.html b/Enums/TzKTBakerTiming.html new file mode 100644 index 00000000..4729553b --- /dev/null +++ b/Enums/TzKTBakerTiming.html @@ -0,0 +1,845 @@ + + + + TzKTBakerTiming Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerTiming

+
+
+ +
public enum TzKTBakerTiming : String, Codable
+ +
+
+

The reliability of the bakers payouts

+ +
+
+
+
    +
  • +
    + + + + stable + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case stable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unstable + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unstable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + suspicious + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case suspicious
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + no_data + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case no_data
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/WalletError.html b/Enums/WalletError.html new file mode 100644 index 00000000..cbe1c5c2 --- /dev/null +++ b/Enums/WalletError.html @@ -0,0 +1,767 @@ + + + + WalletError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletError

+
+
+ +
public enum WalletError : Error
+ +
+
+

Possible error types that can occur when using the LedgerWallet

+ +
+
+
+
    +
  • +
    + + + + signatureError + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case signatureError
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Enums/WalletType.html b/Enums/WalletType.html new file mode 100644 index 00000000..df43bc4b --- /dev/null +++ b/Enums/WalletType.html @@ -0,0 +1,845 @@ + + + + WalletType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletType

+
+
+ +
public enum WalletType : String, Codable
+ +
+
+

Enum to distingush between linear (non-hd) wallets, using the Bip39 standard, and hd wallets using the Bip44 standard.

+ +
+
+
+
    +
  • +
    + + + + regular + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case regular
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hd + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case hd
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + social + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case social
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ledger + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ledger
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Error/index.html b/Error/index.html deleted file mode 100644 index 0eec85cd..00000000 --- a/Error/index.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - KukaiCoreSwift - Error - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - Error -

-
-

Properties

- -
-

- code -

-
-
var code: Int  
-
-
-

Access NSError.code

- -
-
-
-

- domain -

-
-
var domain: String  
-
-
-

Access NSError.domain

- -
-
-
-

- user​Info -

-
-
var userInfo: [String: Any]  
-
-
-

Access NSError.userInfo

- -
-
-
-

- underlying​Error -

-
-
var underlyingError: NSError?  
-
-
-

Access NSError.userInfo[NSUnderlyingErrorKey] and cast to swift Error

- -
-
-
-
-
- - - - diff --git a/ErrorHandlingService/index.html b/ErrorHandlingService/index.html deleted file mode 100644 index 35fb266c..00000000 --- a/ErrorHandlingService/index.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - KukaiCoreSwift - ErrorHandlingService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Error​Handling​Service -

- -
-
public class ErrorHandlingService  
-
-
-

A class used to process errors into more readable format, and optionally notifiy a global error handler of every error occuring

- -
- -
-

Properties

- -
-

- shared -

-
-
public static let shared  
-
-
-

Shared instance so that it can hold onto an event closure

- -
-
-
-

- error​Event​Closure -

-
-
public var errorEventClosure: ((KukaiError) -> Void)? = nil
-
-
-

Called everytime an error is parsed. Extremely useful to track / log errors globally, in order to run logic or record to external service

- -
-
-
-
-

Methods

- -
-

- from​Operation​Error(_:​and​Log:​) -

-
-
public static func fromOperationError(_ opError: OperationResponseInternalResultError, andLog: Bool = true) -> KukaiError  
-
-
-

Convert an OperationResponseInternalResultError into a KukaiError and optionally log it to the central logger

- -
-
-
-

- search​Operation​Response​For​Errors(_:​and​Log:​) -

-
-
public static func searchOperationResponseForErrors(_ opResponse: OperationResponse, andLog: Bool = true) -> KukaiError?  
-
-
-

Search an OperationResponse to see does it contain any errors, if so return the last one as a KukaiError and optionally log it to the central logger

- -
-
-
-

- search​Operation​Response​For​Errors(_:​and​Log:​) -

-
-
public static func searchOperationResponseForErrors(_ opResponse: [OperationResponse], andLog: Bool = true) -> KukaiError?  
-
-
-

Search an [OperationResponse] to see does it contain any errors, if so return the last one as aKukaiError and optionally log it to the central logger

- -
-
-
-

- search​For​System​Error(data:​response:​network​Error:​request​URL:​request​Data:​and​Log:​) -

-
-
public static func searchForSystemError(data: Data?, response: URLResponse?, networkError: Error?, requestURL: URL, requestData: Data?, andLog: Bool = true) -> KukaiError?  
-
-
-

Take in network response data and see does it contain an error, if so return create aKukaiErrorfrom it and optionally log it to the central logger

- -
-
-
- - - -
-
- - - - diff --git a/Extensions.html b/Extensions.html new file mode 100644 index 00000000..d2450608 --- /dev/null +++ b/Extensions.html @@ -0,0 +1,1167 @@ + + + + Extensions Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Extensions

+

The following extensions are available globally.

+ +
+
+
+
    +
  • +
    + + + + Collection + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Collection
    +
    public extension Collection where Element: Publisher
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Date + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Date
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DateFormatter + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension DateFormatter
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Decimal + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Error + +
    +
    +
    +
    +
    +
    +

    Exposing underlying NSError properties not accessible to Swift Error without casting

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Logger + +
    +
    +
    +
    +
    +
    +

    Extension to OSLog to create some custom categories for logging

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Publisher + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Publisher
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + AnyPublisher + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension AnyPublisher
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Result + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Result
    +
    public extension Result where Failure == KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + String + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Thread + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Thread
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NSImage + +
    +
    +
    +
    +
    +
    +

    Create standard UIImage properties and methods

    + + See more +
    +
    +
    +
  • +
  • +
    + + + + LossyCodableList + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    extension LossyCodableList: Decodable where Element: Decodable
    +
    extension LossyCodableList: Encodable where Element: Encodable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Dictionary + +
    +
    +
    +
    +
    +
    +

    Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Dictionary where Key == String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Array + +
    +
    +
    +
    +
    +
    +

    Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Array where Element == [String: Any]
    +
    public extension Array where Element == Any
    +
    extension Array where Element == Operation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension KeyedDecodingContainer
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/AnyPublisher.html b/Extensions/AnyPublisher.html new file mode 100644 index 00000000..cfc9a7fc --- /dev/null +++ b/Extensions/AnyPublisher.html @@ -0,0 +1,848 @@ + + + + AnyPublisher Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

AnyPublisher

+
+
+ +
public extension AnyPublisher
+ +
+
+ +
+
+
+
    +
  • +
    + + + + just(_:) + +
    +
    +
    +
    +
    +
    +

    Helper for returning a Just publisher, with the appropriate Failure type and erased to AnyPublisher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static func just(_ output: Output) -> AnyPublisher<Output, Failure>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fail(with:) + +
    +
    +
    +
    +
    +
    +

    Helper for returning a Fail publisher, erased to AnyPublisher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static func fail(with error: Failure) -> AnyPublisher<Output, Failure>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + onReceiveOutput(_:) + +
    +
    +
    +
    +
    +
    +

    Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func onReceiveOutput(_ callback: @escaping ((`Self`.Output) -> Void)) -> Publishers.HandleEvents<`Self`>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func sink(onError: @escaping ((Failure) -> Void), onSuccess: @escaping ((Output) -> Void), onComplete: (() -> Void)? = nil) -> AnyCancellable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/Array.html b/Extensions/Array.html new file mode 100644 index 00000000..f91c5ef3 --- /dev/null +++ b/Extensions/Array.html @@ -0,0 +1,988 @@ + + + + Array Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Array

+
+
+ +
public extension Array where Element == [String: Any]
+
public extension Array where Element == Any
+
extension Array where Element == Operation
+ +
+
+

Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

+ +
+
+
+
+ + +
+ +

Available where Element == [String: Any] +

+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonInt(atIndex index: Int) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonString(atIndex index: Int) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonPair(atIndex index: Int) -> [String : Any]?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Element == Any +

+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonInt(atIndex index: Int) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonString(atIndex index: Int) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonPair(atIndex index: Int) -> [String : Any]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonArray(atIndex index: Int) -> [Any]?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Element == Operation +

+
+
+
    +
  • +
    + + + + copyOperations() + +
    +
    +
    +
    +
    +
    +

    Operation’s are classes, passed by reference, but often require making copies so that you can manipulate them before sending to be estimated. +Function make it easy by converting the array to JSON and recreating, avoiding issues where construnctors manipulate inputs before storing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func copyOperations() -> [Operation]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/Collection.html b/Extensions/Collection.html new file mode 100644 index 00000000..7c87e84b --- /dev/null +++ b/Extensions/Collection.html @@ -0,0 +1,808 @@ + + + + Collection Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Collection

+
+
+ +
public extension Collection
+
public extension Collection where Element: Publisher
+ +
+
+ +
+
+
+
    +
  • +
    + + + + subscript(safe:) + +
    +
    +
    +
    +
    +
    +

    Returns the element at the specified index if it is within bounds, otherwise nil.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    subscript(safe index: Index) -> Element? { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Element: Publisher +

+
+
+ +
+
+
+ +
+
+ + diff --git a/Extensions/Date.html b/Extensions/Date.html new file mode 100644 index 00000000..4933cbcf --- /dev/null +++ b/Extensions/Date.html @@ -0,0 +1,767 @@ + + + + Date Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Date

+
+
+ +
public extension Date
+ +
+
+ +
+
+
+
    +
  • +
    + + + + timeAgoDisplay() + +
    +
    +
    +
    +
    +
    +

    Helper to return strings like “15 seconds ago”, “1 minute ago” etc, from a Date

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func timeAgoDisplay() -> String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/DateFormatter.html b/Extensions/DateFormatter.html new file mode 100644 index 00000000..9f46f2d1 --- /dev/null +++ b/Extensions/DateFormatter.html @@ -0,0 +1,767 @@ + + + + DateFormatter Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DateFormatter

+
+
+ +
public extension DateFormatter
+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(withFormat:) + +
    +
    +
    +
    +
    +
    +

    Helper to create a DateFormatter with a format in 1 call

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    convenience init(withFormat: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/Decimal.html b/Extensions/Decimal.html new file mode 100644 index 00000000..8f65e012 --- /dev/null +++ b/Extensions/Decimal.html @@ -0,0 +1,794 @@ + + + + Decimal Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Decimal

+
+
+ +
public extension Decimal
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Wrapper around the Objective-c code needed to round a Decimal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func rounded(scale: Int, roundingMode: NSDecimalNumber.RoundingMode) -> Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + intValue() + +
    +
    +
    +
    +
    +
    +

    Wrapper around the Objective-c code needed to return an Int from a decimal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func intValue() -> Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/Dictionary.html b/Extensions/Dictionary.html new file mode 100644 index 00000000..ec37b590 --- /dev/null +++ b/Extensions/Dictionary.html @@ -0,0 +1,906 @@ + + + + Dictionary Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Dictionary

+
+
+ +
public extension Dictionary where Key == String
+ +
+
+

Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

+ +
+
+
+
+ + +
+ +

Available where Key == String +

+
+
+
    +
  • +
    + + + + michelsonValue() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonValue() -> [String : Any]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonValueArray() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonValueArray() -> [[String : Any]]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonArgsArray() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonArgsArray() -> [[String : Any]]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonArgsUnknownArray() -> [Any]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonInt() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonInt() -> String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonString() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonString() -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/Error.html b/Extensions/Error.html new file mode 100644 index 00000000..8134b863 --- /dev/null +++ b/Extensions/Error.html @@ -0,0 +1,849 @@ + + + + Error Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Error

+
+
+ +
public extension Error
+ +
+
+

Exposing underlying NSError properties not accessible to Swift Error without casting

+ +
+
+
+
    +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    Access NSError.code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var code: Int { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + domain + +
    +
    +
    +
    +
    +
    +

    Access NSError.domain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var domain: String { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + userInfo + +
    +
    +
    +
    +
    +
    +

    Access NSError.userInfo

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var userInfo: [String : Any] { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + underlyingError + +
    +
    +
    +
    +
    +
    +

    Access NSError.userInfo[NSUnderlyingErrorKey] and cast to swift Error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var underlyingError: NSError? { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/KeyedDecodingContainer.html b/Extensions/KeyedDecodingContainer.html new file mode 100644 index 00000000..34f7d87b --- /dev/null +++ b/Extensions/KeyedDecodingContainer.html @@ -0,0 +1,793 @@ + + + + KeyedDecodingContainer Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

KeyedDecodingContainer

+
+
+ +
public extension KeyedDecodingContainer
+ +
+
+ +
+
+
+
    +
  • +
    + + + + decode(_:forKey:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func decode<T>(_ type: NilOnDecodingError<T>.Type, forKey key: `Self`.Key) throws -> NilOnDecodingError<T> where T : Decodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    In case where people have not followed the spec correctly, and named keys slightly differently, allow a second key to be used so that, for example, we could check for artifcatUri or artifact_uri in one call

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func decodeIfPresent<T>(_ type: T.Type, forKey key: `Self`.Key, orBackupKey: `Self`.Key) throws -> T? where T : Decodable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/Logger.html b/Extensions/Logger.html new file mode 100644 index 00000000..d7e0feda --- /dev/null +++ b/Extensions/Logger.html @@ -0,0 +1,1028 @@ + + + + Logger Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Logger

+
+
+ +
public extension Logger
+ +
+
+

Extension to OSLog to create some custom categories for logging

+ +
+
+
+
    +
  • +
    + + + + kukaiCoreSwift + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let kukaiCoreSwift: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + walletCache + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let walletCache: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + kukaiCoreSwiftError + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let kukaiCoreSwiftError: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + keychain + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let keychain: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + network + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let network: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bcd + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let bcd: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzkt + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let tzkt: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + taquitoService + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let taquitoService: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + torus + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let torus: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ledger + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let ledger: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + app + +
    +
    +
    +
    +
    +
    +

    Used by the app importing this library

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let app: Logger
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/NSImage.html b/Extensions/NSImage.html new file mode 100644 index 00000000..8e913402 --- /dev/null +++ b/Extensions/NSImage.html @@ -0,0 +1,770 @@ + + + + NSImage Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NSImage

+

Create standard UIImage properties and methods

+ +
+
+
+
    +
  • +
    + + + + cgImage + +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
  • +
  • +
    + + + + init(named:) + +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/Publisher.html b/Extensions/Publisher.html new file mode 100644 index 00000000..e22a9d9f --- /dev/null +++ b/Extensions/Publisher.html @@ -0,0 +1,875 @@ + + + + Publisher Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Publisher

+
+
+ +
public extension Publisher
+ +
+
+ +
+
+
+
    +
  • +
    + + + + asFuture() + +
    +
    +
    +
    +
    +
    +

    Wrap a Publisher in a Future of type <Output, Never>

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func asFuture() -> Future<Output, Never>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + asDeferredFuture() + +
    +
    +
    +
    +
    +
    +

    Wrap a Publisher in a Deferred Future of type <Output, Never>

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func asDeferredFuture() -> Deferred<Future<Output, Never>>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + convertToResult() + +
    +
    +
    +
    +
    +
    +

    Convert a publisher output into a swift Resultobject to make handling sink‘s easier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func convertToResult() -> AnyPublisher<Result<Output, Failure>, Never>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + onReceiveOutput(_:) + +
    +
    +
    +
    +
    +
    +

    Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func onReceiveOutput(_ callback: @escaping ((Self.Output) -> Void)) -> Publishers.HandleEvents<Self>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func sink(onError: @escaping ((Failure) -> Void), onSuccess: @escaping ((Output) -> Void), onComplete: (() -> Void)? = nil) -> AnyCancellable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/Result.html b/Extensions/Result.html new file mode 100644 index 00000000..c930633a --- /dev/null +++ b/Extensions/Result.html @@ -0,0 +1,808 @@ + + + + Result Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Result

+
+
+ +
public extension Result
+
public extension Result where Failure == KukaiError
+ +
+
+ +
+
+
+
    +
  • +
    + + + + getError() + +
    +
    +
    +
    +
    +
    +

    Similar to Result.get(), getError returns the failure case or throws

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func getError() throws -> Failure
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Failure == KukaiError +

+
+
+
    +
  • +
    + + + + getFailure() + +
    +
    +
    +
    +
    +
    +

    Similar to Result.get(), getFailure returns the kukai-core-specific KukaiError case or throws

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func getFailure() -> Failure
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/String.html b/Extensions/String.html new file mode 100644 index 00000000..b2b25185 --- /dev/null +++ b/Extensions/String.html @@ -0,0 +1,794 @@ + + + + String Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

String

+
+
+ +
public extension String
+ +
+
+ +
+
+
+
    +
  • +
    + + + + indexesOf(string:) + +
    +
    +
    +
    +
    +
    +

    Return the starting indexes of each occurnace of the supplied string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func indexesOf(string: String) -> [String.Index]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    When an error is returned in the format proto.012-Psithaca.gas_exhausted.operation, in many cases we only care about the bit after the protocol. This function returns only that piece

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func removeLeadingProtocolFromRPCError() -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Extensions/Thread.html b/Extensions/Thread.html new file mode 100644 index 00000000..fe5adf4e --- /dev/null +++ b/Extensions/Thread.html @@ -0,0 +1,767 @@ + + + + Thread Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Thread

+
+
+ +
public extension Thread
+ +
+
+ +
+
+
+
    +
  • +
    + + + + isRunningXCTest + +
    +
    +
    +
    +
    +
    +

    Check if the given thread is being run from inside an XCTest bundle

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var isRunningXCTest: Bool { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/FaVersion/index.html b/FaVersion/index.html deleted file mode 100644 index 0dc354e8..00000000 --- a/FaVersion/index.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - KukaiCoreSwift - FaVersion - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - FaVersion -

- -
-
public enum FaVersion: String, Codable  
-
-
-

Enum representing the version of tezos "FA" token contracts

- -
-
- -
- - - - - - -%609 - - - -FaVersion - - -FaVersion - - - - - -Codable - -Codable - - - -FaVersion->Codable - - - - - -String - -String - - - -FaVersion->String - - - - - - - - -
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Initializers

- -
-

- init(from:​) -

-
-
public init(from decoder: Decoder) throws  
-
-
-
-
-

Enumeration Cases

- -
-

- fa1_2 -

-
-
case fa1_2 = "fa1.2"
-
-
-
-

- fa2 -

-
-
case fa2
-
-
-
-

- unknown -

-
-
case unknown
-
-
-
- - - -
-
- - - - diff --git a/FailWith/index.html b/FailWith/index.html deleted file mode 100644 index 70d06aef..00000000 --- a/FailWith/index.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - KukaiCoreSwift - FailWith - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Fail​With -

- -
-
public struct FailWith: Codable, Equatable  
-
-
-

The error string, error int (code), or micheline error object returned inside FailWith

- -
-
- -
- - - - - - -%539 - - - -FailWith - - -FailWith - - - - - -Equatable - -Equatable - - - -FailWith->Equatable - - - - - -Codable - -Codable - - - -FailWith->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Equatable
-
-
-
-

Initializers

- -
-

- init(string:​int:​args:​) -

-
-
public init(string: String?, int: String?, args: [[String: String]]?)  
-
-
-
-

- init(from:​) -

-
-
public init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- string -

-
-
public let string: String? 
-
-
-
-

- int -

-
-
public let int: String? 
-
-
-
-

- args -

-
-
public let args: [[String: String]]? 
-
-
-
- - - -
-
- - - - diff --git a/FailWithParser/index.html b/FailWithParser/index.html deleted file mode 100644 index 6f7fc6dd..00000000 --- a/FailWithParser/index.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - KukaiCoreSwift - FailWithParser - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Protocol - Fail​With​Parser -

- -
-
public protocol FailWithParser  
-
-
-

Protocol to allow defining multiple dedicated structs, one for each dApp, that knows how to convert the specific failWith cases into more human readable error messages

- -
-
- -
- - - - - - -%583 - - - -FailWithParser - - -FailWithParser - - - - - -FailWithParserLiquidityBaking - - -FailWithParserLiquidityBaking - - - - - -FailWithParserLiquidityBaking->FailWithParser - - - - - - - - -
-

Types Conforming to Fail​With​Parser

-
-
FailWithParserLiquidityBaking
-

Dedicated "FailWith" parser for the codes received from Liquidity Baking contract

-
-
-
- - - -
-

Requirements

- -
-

- parse(fail​With:​) -

-
-
func parse(failWith: FailWith?) -> String? 
-
-
-

Take in a failWith and return a message

- -
-
-
-
-
- - - - diff --git a/FailWithParserLiquidityBaking/index.html b/FailWithParserLiquidityBaking/index.html deleted file mode 100644 index bd50d0c9..00000000 --- a/FailWithParserLiquidityBaking/index.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - KukaiCoreSwift - FailWithParserLiquidityBaking - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Fail​With​Parser​Liquidity​Baking -

- -
-
public struct FailWithParserLiquidityBaking: FailWithParser  
-
-
-

Dedicated "FailWith" parser for the codes received from Liquidity Baking contract

- -
-
- -
- - - - - - -%203 - - - -FailWithParserLiquidityBaking - - -FailWithParserLiquidityBaking - - - - - -FailWithParser - - -FailWithParser - - - - - -FailWithParserLiquidityBaking->FailWithParser - - - - - - - - -
-

Conforms To

-
-
FailWithParser
-

Protocol to allow defining multiple dedicated structs, one for each dApp, that knows how to convert the specific failWith cases into more human readable error messages

-
-
-
-
-

Methods

- -
-

- parse(fail​With:​) -

-
-
public func parse(failWith: FailWith?) -> String?  
-
-
-
- - - -
-
- - - - diff --git a/FeeEstimatorService/index.html b/FeeEstimatorService/index.html deleted file mode 100644 index a49b2089..00000000 --- a/FeeEstimatorService/index.html +++ /dev/null @@ -1,339 +0,0 @@ - - - - - - KukaiCoreSwift - FeeEstimatorService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Fee​Estimator​Service -

- -
-
public class FeeEstimatorService  
-
-
-

An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker. -This avoids the need to ask users to enter a fee, which is not a very user friendly approach as most users wouldn't know what is required.

- -
-
- - -

Nested Types

-
-
FeeEstimatorService.FeeConstants
-

Constants needed to compute a fee

-
-
FeeEstimatorService.FeeEstimatorServiceError
-

Various possible errors that can occur during an Estimation

-
-
FeeEstimatorService.EstimationResult
-
-
-
-
-

Initializers

- -
-

- init(config:​operation​Service:​network​Service:​) -

-
-
public init(config: TezosNodeClientConfig = TezosNodeClientConfig(withDefaultsForNetworkType: .mainnet), operationService: OperationService, networkService: NetworkService)  
-
-
-

Create a FeeEstimatorService that will allow developers to automatically create fees on the users behalf

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
operation​ServiceOperation​Service

The OperationService used to perform the forging.

-
network​ServiceNetwork​Service

The NetworkService that will handle the remote communication.

-
-
-
-
-

Properties

- -
-

- default​Signature -

-
-
public static let defaultSignature  
-
-
-

The real signature is not needed for estimation, use the default "Zero Signature" instead

- -
-
-
-

- default​Signature​Hex -

-
-
public static let defaultSignatureHex  
-
-
-
-

- config -

-
-
public let config: TezosNodeClientConfig
-
-
-

The configuration object containing all the necessary settings to connect and communicate with the Tezos node

- -
-
-
-

- operation​Service -

-
-
public let operationService: OperationService
-
-
-

The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

- -
-
-
-

- network​Service -

-
-
public let networkService: NetworkService
-
-
-

The NetworkService that will handle the remote communication.

- -
-
-
-
-

Methods

- -
-

- estimate(operations:​operation​Metadata:​constants:​wallet​Address:​base58Encoded​Public​Key:​completion:​) -

-
-
public func estimate(operations: [Operation], operationMetadata: OperationMetadata, constants: NetworkConstants, walletAddress: String, base58EncodedPublicKey: String, completion: @escaping ((Result<EstimationResult, KukaiError>) -> Void))  
-
-
-

Pass in an array of Operation subclasses (use OperationFacotry to create) to have the library estimate the cost of sending the transaction. Function will use local or remote forging based off config passed in. -If the supplied operations contain suggested fees (e.g. from a dApp) this function will estimate the fee and pick which ever is higher

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
operations[Operation]

An array of Operation subclasses to be estimated.

-
operation​MetadataOperation​Metadata

An OperationMetadata object containing necessary info about the current blockchain state.

-
network​Constants

A NetworkConstants used to provide information about the current network requirements.

-
with​Wallet

The Wallet object used for signing the transaction.

-
completion@escaping ((Result<Estimation​Result, Kukai​Error>) -> Void)

A callback containing the same operations passed in, modified to include fees.

-
-
-
-

- extract​Fees(from​Operation​Response:​forged​Hash:​with​Constants:​) -

-
-
public func extractFees(fromOperationResponse operationResponse: OperationResponse, forgedHash: String, withConstants constants: NetworkConstants) -> [OperationFees]  
-
-
-

Create an array of OperationFees from an OperationResponse.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
from​Operation​ResponseOperation​Response

The OperationResponse resulting from an RPC call to .../run_operation.

-
forged​HashString

The forged hash string resulting from a call to TezosNodeClient.forge(...)

-
-

Returns

-

An array of OperationFees

- -
-
-

- fee​For​Gas(_:​) -

-
-
public static func feeForGas(_ gas: Int) -> XTZAmount  
-
-
-

Calculate the fee to add for the given amount of gas

- -
-
-
-

- fee​For​Storage(_:​number​OfOperations:​) -

-
-
public static func feeForStorage(_ forgedHexString: String, numberOfOperations: Int) -> XTZAmount  
-
-
-

Calculate the fee to add based on the size of the forged string

- -
-
-
-

- fee​For​Burn(_:​with​Constants:​) -

-
-
public static func feeForBurn(_ burn: Int, withConstants contants: NetworkConstants) -> XTZAmount  
-
-
-

Calculate the fee to add based on how many bytes of storage where needed

- -
-
-
-

- nano​Tezto​XTZ(_:​) -

-
-
public static func nanoTeztoXTZ(_ nanoTez: NanoTez) -> XTZAmount  
-
-
-

Most calcualtions are documented in NanoTez, which is not accpeted by the network RPC calls. Needs to be converted to Mutez / XTZ

- -
-
-
-

- fee(for​Gas​Limit:​forged​Hex​String:​number​OfOperations:​) -

-
-
public static func fee(forGasLimit gasLimit: Int, forgedHexString: String, numberOfOperations: Int) -> XTZAmount  
-
-
-
-

- add​Gas​Safety​Margin​To(gas​Used:​) -

-
-
public static func addGasSafetyMarginTo(gasUsed: Int) -> Int  
-
-
-
- - - -
-
- - - - diff --git a/FeeEstimatorService_EstimationResult/index.html b/FeeEstimatorService_EstimationResult/index.html deleted file mode 100644 index 052e42c3..00000000 --- a/FeeEstimatorService_EstimationResult/index.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - KukaiCoreSwift - FeeEstimatorService.EstimationResult - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Fee​Estimator​Service.​Estimation​Result -

- -
-
public struct EstimationResult: Codable  
-
-
- -
- - - - - - -%221 - - - -FeeEstimatorService.EstimationResult - - -FeeEstimatorService.EstimationResult - - - - - -Codable - -Codable - - - -FeeEstimatorService.EstimationResult->Codable - - - - - - - - -
-

Member Of

-
-
FeeEstimatorService
-

An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker. -This avoids the need to ask users to enter a fee, which is not a very user friendly approach as most users wouldn't know what is required.

-
-
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- operations -

-
-
public let operations: [Operation] 
-
-
-
-

- forged​String -

-
-
public let forgedString: String
-
-
-
- - - -
-
- - - - diff --git a/FeeEstimatorService_FeeConstants/index.html b/FeeEstimatorService_FeeConstants/index.html deleted file mode 100644 index 1577cc22..00000000 --- a/FeeEstimatorService_FeeConstants/index.html +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - KukaiCoreSwift - FeeEstimatorService.FeeConstants - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Fee​Estimator​Service.​Fee​Constants -

- -
-
public struct FeeConstants  
-
-
-

Constants needed to compute a fee

- -
-
- - -

Member Of

-
-
FeeEstimatorService
-

An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker. -This avoids the need to ask users to enter a fee, which is not a very user friendly approach as most users wouldn't know what is required.

-
-
-
-
-

Properties

- -
-

- nano​Tez​Per​Mutez -

-
-
public static let nanoTezPerMutez: Int = 1000
-
-
-
-

- minimal​Fee -

-
-
public static let minimalFee: NanoTez = 100_000
-
-
-
-

- fee​Per​Gas​Unit -

-
-
public static let feePerGasUnit: NanoTez = 100
-
-
-
-

- fee​Per​Storage​Byte -

-
-
public static let feePerStorageByte: NanoTez = 1000
-
-
-
-

- base​Fee -

-
-
public static let baseFee  
-
-
-
- - - -
-
- - - - diff --git a/FeeEstimatorService_FeeEstimatorServiceError/index.html b/FeeEstimatorService_FeeEstimatorServiceError/index.html deleted file mode 100644 index 3c8a5ff2..00000000 --- a/FeeEstimatorService_FeeEstimatorServiceError/index.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - KukaiCoreSwift - FeeEstimatorService.FeeEstimatorServiceError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Fee​Estimator​Service.​Fee​Estimator​Service​Error -

- -
-
public enum FeeEstimatorServiceError: Error  
-
-
-

Various possible errors that can occur during an Estimation

- -
-
- -
- - - - - - -%793 - - - -FeeEstimatorService.FeeEstimatorServiceError - - -FeeEstimatorService.FeeEstimatorServiceError - - - - - -Error - -Error - - - -FeeEstimatorService.FeeEstimatorServiceError->Error - - - - - - - - -
-

Member Of

-
-
FeeEstimatorService
-

An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker. -This avoids the need to ask users to enter a fee, which is not a very user friendly approach as most users wouldn't know what is required.

-
-
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- tezos​Node​Client​Not​Present -

-
-
case tezosNodeClientNotPresent
-
-
-
-

- unable​ToSetup​Run​Operation -

-
-
case unableToSetupRunOperation
-
-
-
-

- invalid​Number​OfFees​Returned -

-
-
case invalidNumberOfFeesReturned
-
-
-
-

- failed​ToCopy​Operations -

-
-
case failedToCopyOperations
-
-
-
-

- estimation​Remote​Error -

-
-
case estimationRemoteError(errors: [OperationResponseInternalResultError]?) 
-
-
-
- - - -
-
- - - - diff --git a/GraphQLError/index.html b/GraphQLError/index.html deleted file mode 100644 index 6f368343..00000000 --- a/GraphQLError/index.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - KukaiCoreSwift - GraphQLError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Graph​QLError -

- -
-
public struct GraphQLError: Codable  
-
-
-

GraphQL error object

- -
-
- -
- - - - - - -%389 - - - -GraphQLError - - -GraphQLError - - - - - -Codable - -Codable - - - -GraphQLError->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- message -

-
-
public let message: String
-
-
-

Message sent from the server explaining the issue

- -
-
-
-

- locations -

-
-
public let locations: [String: String]? 
-
-
-

Identifying the location fo the issue. E.g. codefile and line, or location of unexpected character/symbol in request string

- -
-
-
-

- extenstions -

-
-
public let extenstions: [String: String]? 
-
-
-

Not sure, but it shows up sometimes

- -
-
-
- - - -
-
- - - - diff --git a/GraphQLResponse/index.html b/GraphQLResponse/index.html deleted file mode 100644 index 220fae3d..00000000 --- a/GraphQLResponse/index.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - KukaiCoreSwift - GraphQLResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Graph​QLResponse -

- -
-
public struct GraphQLResponse<T: Codable>: Codable  
-
-
-

Simple model object to wrap a GraphQL response to expose a Codable response without having to use large GraphQL libraries

- -
-
- -
- - - - - - -%385 - - - -GraphQLResponse - - -GraphQLResponse - - - - - -Codable - -Codable - - - -GraphQLResponse->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- errors -

-
-
public let errors: [GraphQLError]? 
-
-
-

Array of errors returned from the server

- -
-
-
-

- data -

-
-
public let data: T? 
-
-
-

Generic data type matching the user supplied type

- -
-
-
- - - -
-
- - - - diff --git a/HDWallet/index.html b/HDWallet/index.html deleted file mode 100644 index b555d06c..00000000 --- a/HDWallet/index.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - KukaiCoreSwift - HDWallet - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - HDWallet -

- -
-
public class HDWallet: Wallet  
-
-
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

- -
-
-

This wallet is a HD wallet, allowing the creation of many child wallets from the one base privateKey. It also follows the Bip39 stnadard for generation via a mnemonic.

- -
-
- -
- - - - - - -%625 - - - -HDWallet - - -HDWallet - - - - - -Hashable - -Hashable - - - -HDWallet->Hashable - - - - - -Wallet - - -Wallet - - - - - -HDWallet->Wallet - - - - - -Equatable - -Equatable - - - -HDWallet->Equatable - - - - - - - - -
-

Conforms To

-
-
Wallet
-

Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

-
-
Equatable
-
Hashable
-
-
-
-

Initializers

- -
-

- init?(with​Mnemonic:​passphrase:​derivation​Path:​) -

-
-
public init?(withMnemonic mnemonic: Mnemonic, passphrase: String, derivationPath: String = HD.defaultDerivationPath)  
-
-
-

Create a HDWallet by supplying a mnemonic string and a passphrase (or "" if none).

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
with​MnemonicMnemonic

A Mnemonic representing a BIP39 menmonic

-
passphraseString

String contianing a passphrase, or empty string if none

-
derivation​PathString

Optional: use a different derivation path to the default HDWallet.defaultDerivationPath

-
-
-
-

- init?(with​Mnemonic​Length:​passphrase:​derivation​Path:​) -

-
-
public convenience init?(withMnemonicLength length: Mnemonic.NumberOfWords, passphrase: String, derivationPath: String = HD.defaultDerivationPath)  
-
-
-

Create a HDWallet by asking for a mnemonic of a given number of words and a passphrase (or "" if none).

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
with​Mnemonic​LengthMnemonic.​Number​OfWords

Mnemonic.NumberOfWords the number of words to use when creating a mnemonic

-
passphraseString

String contianing a passphrase, or empty string if none

-
derivation​PathString

Optional: use a different derivation path to the default HDWallet.defaultDerivationPath

-
-
-
-
-

Properties

- -
-

- type -

-
-
public let type: WalletType
-
-
-

The underlying wallet type, set to .hd

- -
-
-
-

- address -

-
-
public var address: String
-
-
-

The public TZ1 address of the wallet

- -
-
-
-

- private​Key -

-
-
public var privateKey: PrivateKey
-
-
-

An WalletCore object representing the PrivateKey used to generate the wallet

- -
-
-
-

- public​Key -

-
-
public var publicKey: PublicKey
-
-
-

An WalletCore object representing the PublicKey used to generate the wallet address

- -
-
-
-

- mnemonic -

-
-
public var mnemonic: Mnemonic
-
-
-

The Bip39 mnemonic used to generate the wallet

- -
-
-
-

- derivation​Path -

-
-
public var derivationPath: String
-
-
-

The Bip44 derivationPath used to create the wallet

- -
-
-
-
-

Methods

- -
-

- sign(_:​is​Operation:​completion:​) -

-
-
public func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))  
-
-
-

Sign a hex payload with the private key

- -
-
-
-

- private​Key​Curve() -

-
-
public func privateKeyCurve() -> EllipticalCurve  
-
-
-

Return the curve used to create the key

- -
-
-
-

- public​Key​Base58encoded() -

-
-
public func publicKeyBase58encoded() -> String  
-
-
-

Get a Base58 encoded version of the public key, in order to reveal the address on the network

- -
-
-
-

- create​Child(account​Index:​) -

-
-
public func createChild(accountIndex: Int) -> HDWallet?  
-
-
-

The default implementation in Ledger is to not give users the option to provide their own derivation path, but instead increment the "account" field by 1 each time. -This function will create a new HDWallet, by taking the default derivation path and changing the account to the index supplied, and using the same key

- -
-
-
-

- create​Child(derivation​Path:​) -

-
-
public func createChild(derivationPath: String) -> HDWallet?  
-
-
-

This function will create a new HDWallet, by using the same key combined with the supplied derivationPath

- -
-
-
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: HDWallet, rhs: HDWallet) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/HDWalletError/index.html b/HDWalletError/index.html deleted file mode 100644 index 47a901b0..00000000 --- a/HDWalletError/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - KukaiCoreSwift - HDWalletError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - HDWallet​Error -

- -
-
public enum HDWalletError: Error  
-
-
-

Error types that can be passed by failable inits

- -
-
- -
- - - - - - -%441 - - - -HDWalletError - - -HDWalletError - - - - - -Error - -Error - - - -HDWalletError->Error - - - - - - - - -
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- invalid​Wallet​Core​Wallet -

-
-
case invalidWalletCoreWallet
-
-
-
- - - -
-
- - - - diff --git a/KeyedDecodingContainer/index.html b/KeyedDecodingContainer/index.html deleted file mode 100644 index 572226c3..00000000 --- a/KeyedDecodingContainer/index.html +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - KukaiCoreSwift - KeyedDecodingContainer - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - KeyedDecodingContainer -

-
-

Methods

- -
-

- decode(_:​for​Key:​) -

-
-
func decode<T>(_ type: NilOnDecodingError<T>.Type, forKey key: Self.Key) throws -> NilOnDecodingError<T> where T: Decodable  
-
-
-
-

- decode​IfPresent(_:​for​Key:​or​Backup​Key:​) -

-
-
func decodeIfPresent<T>(_ type: T.Type, forKey key: Self.Key, orBackupKey: Self.Key) throws -> T? where T: Decodable  
-
-
-

In case where people have not followed the spec correctly, and named keys slightly differently, allow a second key to be used so that, for example, we could check for artifcatUri or artifact_uri in one call

- -
-
-
-
-
- - - - diff --git a/KukaiError/index.html b/KukaiError/index.html deleted file mode 100644 index 29d63220..00000000 --- a/KukaiError/index.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - - KukaiCoreSwift - KukaiError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Kukai​Error -

- -
-
public struct KukaiError: CustomStringConvertible, Error  
-
-
-

A struct conforming to Error, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves. -Comes with helpers to extract meaning from RPC errors, optionally includes all the network data that caused the error for easier retrieval, and a fallback human readbale description to ensure something useful is always shown to the user.

- -
-
- -
- - - - - - -%185 - - - -KukaiError - - -KukaiError - - - - - -Error - -Error - - - -KukaiError->Error - - - - - -CustomStringConvertible - -CustomStringConvertible - - - -KukaiError->CustomStringConvertible - - - - - - - - -
-

Nested Types

-
-
KukaiError.ErrorType
-

Categories of errors that are possible

-
-
-

Conforms To

-
-
CustomStringConvertible
-
Error
-
-
-
-

Properties

- -
-

- error​Type -

-
-
public let errorType: ErrorType
-
-
-

The error category

- -
-
-
-

- sub​Type -

-
-
public let subType: Error? 
-
-
-

Optional error subType coming from another source (the OS, URLSession, another library etc)

- -
-
-
-

- rpc​Error​String -

-
-
public let rpcErrorString: String? 
-
-
-

Optional string containing only the relvant portion of an RPC error (e.g instead of "proto.xxxxxxxx.gas_exhausted.operation", it would contain "gas_exhausted.operation") to make parsing easier

- -
-
-
-

- fail​With -

-
-
public let failWith: FailWith? 
-
-
-

Optional object containing smart contract failure casues. May contain an Int (error code), a String (semi human readbale error message), and/or a dictionary containing metadata

- -
-
-
-

- request​URL -

-
-
public var requestURL: URL? 
-
-
-

The requested URL that returned the error

- -
-
-
-

- request​JSON -

-
-
public var requestJSON: String? 
-
-
-

The JSON that was sent as part of the request

- -
-
-
-

- response​JSON -

-
-
public var responseJSON: String? 
-
-
-

The raw JSON that was returned

- -
-
-
-

- http​Status​Code -

-
-
public var httpStatusCode: Int? 
-
-
-

The HTTP status code returned

- -
-
-
-

- description -

-
-
public var description: String  
-
-
-

Prints the underlying error type with either an RPC string, or an underlying Error object contents

- -
-
-
-
-

Methods

- -
-

- rpc​Error(rpc​Error​String:​and​Fail​With:​) -

-
-
public static func rpcError(rpcErrorString: String, andFailWith: FailWith?) -> KukaiError  
-
-
-

Create a KukaiError from an RPC string (will not be validated). You can use the string extension .removeLeadingProtocolFromRPCError() to strip the leading poriton of the error

- -
-
-
-

- system​Error(sub​Type:​) -

-
-
public static func systemError(subType: Error) -> KukaiError  
-
-
-

Create a KukaiError denoting a sytem issue from the OS, by passing in the system Error type

- -
-
-
-

- network​Error(status​Code:​) -

-
-
public static func networkError(statusCode: Int) -> KukaiError  
-
-
-

Create a KukaiError denoting a network issue, by passing in the HTTP status code

- -
-
-
-

- internal​Application​Error(error:​) -

-
-
public static func internalApplicationError(error: Error) -> KukaiError  
-
-
-

Create a KukaiError denoting an issue from some other component or library, by passing in the error that piece of code returned

- -
-
-
-

- unknown(with​String:​) -

-
-
public static func unknown(withString: String? = nil) -> KukaiError  
-
-
-

Create an unknown KukaiError

- -
-
-
-

- add​Network​Data(request​URL:​request​JSON:​response​JSON:​http​Status​Code:​) -

-
-
public mutating func addNetworkData(requestURL: URL?, requestJSON: Data?, responseJSON: Data?, httpStatusCode: Int?)  
-
-
-

For network errors, attach all the necessary network data that may be needed in order to debug the issue, or log to a tool such as sentry

- -
-
-
- - - -
-
- - - - diff --git a/KukaiError_ErrorType/index.html b/KukaiError_ErrorType/index.html deleted file mode 100644 index 5d873d2d..00000000 --- a/KukaiError_ErrorType/index.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - KukaiCoreSwift - KukaiError.ErrorType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Kukai​Error.​Error​Type -

- -
-
public enum ErrorType: Equatable  
-
-
-

Categories of errors that are possible

- -
-
- -
- - - - - - -%47 - - - -KukaiError.ErrorType - - -KukaiError.ErrorType - - - - - -Equatable - -Equatable - - - -KukaiError.ErrorType->Equatable - - - - - - - - -
-

Member Of

-
-
KukaiError
-

A struct conforming to Error, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves. -Comes with helpers to extract meaning from RPC errors, optionally includes all the network data that caused the error for easier retrieval, and a fallback human readbale description to ensure something useful is always shown to the user.

-
-
-

Conforms To

-
-
Equatable
-
-
-
-

Enumeration Cases

- -
-

- rpc -

-
-
case rpc
-
-
-

RPC errors come directly from the Tezos RPC, but with the massive JSON object filtered down to the most meraningful part

- -
-
-
-

- system -

-
-
case system
-
-
-

System errors are ones coming from the OS, e.g. "No internet connection"

- -
-
-
-

- network -

-
-
case network(Int) 
-
-
-

Network errors are returned by a server, such as HTTP 404's and 500's

- -
-
-
-

- internal​Application -

-
-
case internalApplication
-
-
-

Internal application errors are errors from other services, components, libraiers etc, wrapped up so that they don't require extra parsing

- -
-
-
-

- unknown -

-
-
case unknown
-
-
-

Used as a fallback for strange edge cases where we can't easily idenitfiy the issue

- -
-
-
- - - -
-
- - - - diff --git a/LedgerService/index.html b/LedgerService/index.html deleted file mode 100644 index d1b1d6cd..00000000 --- a/LedgerService/index.html +++ /dev/null @@ -1,459 +0,0 @@ - - - - - - KukaiCoreSwift - LedgerService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Ledger​Service -

- -
-
public class LedgerService: NSObject, CBPeripheralDelegate, CBCentralManagerDelegate  
-
-
-

A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

- -
-
-

Ledger only provide a ReactNative module for third parties to integrate with. The architecture of the module also makes it very difficult to -integrate with native mobile (if it can be packaged up) as it relies heavily on long observable chains passing through many classes and functions. -To overcome this, I copied the base logic from multiple ledgerjs classes into a single typescript file and split the functions up into more of a utility style class, where -each function returns a result, that must be passed into another function. This allowed the creation of a swift class to sit in the middle of these -functions and decide what to do with the responses.

- -

The modified typescript can be found in this file (under a fork of the main repo) https://github.com/simonmcl/ledgerjs/blob/native-mobile/packages/hw-app-tezos/src/NativeMobileTezos.ts . -The containing package also includes a webpack file, which will package up the typescript and its dependencies into mobile friendly JS file, which -needs to be included in the swift project. Usage of the JS can be seen below.

- -

NOTE: this modified typescript is Tezos only as I was unable to find a way to simply subclass their Transport class, to produce a re-usable -NativeMobile transport. The changes required modifiying the app and other class logic which became impossible to refactor back into the project, without rewriting everything.

- -
-
- -
- - - - - - -%59 - - - -LedgerService - - -LedgerService - - - - - -CBCentralManagerDelegate - -CBCentralManagerDelegate - - - -LedgerService->CBCentralManagerDelegate - - - - - -NSObject - -NSObject - - - -LedgerService->NSObject - - - - - -CBPeripheralDelegate - -CBPeripheralDelegate - - - -LedgerService->CBPeripheralDelegate - - - - - - - - -
-

Nested Types

-
-
LedgerService.GeneralErrorCodes
-

General Ledger error codes, pulled from the source, and some additional ones added for native swift issues

-
-
LedgerService.TezosAppErrorCodes
-

Dedicated error codes pulled from the Ledger tezos app

-
-
-

Conforms To

-
-
CBCentralManagerDelegate
-
CBPeripheralDelegate
-
NSObject
-
-
-
-

Properties

- -
-

- success​Code -

-
-
public static let successCode = "9000"
-
-
-

Instead of returning data, sometimes ledger returns a code to indicate that so far the message have been received successfully

- -
-
-
-

- partial​Success​Message​Received -

-
-
@Published public var partialSuccessMessageReceived: Bool = false
-
-
-

Be notified when the ledger device returns a success message, part way through the process. -This can be useful to indicate to users that the request has succeed, but s waiting on input on the Ledger device to continue

- -
-
-
-

- shared -

-
-
public static let shared  
-
-
-

Public shared instace to avoid having multiple copies of the underlying JSContext created

- -
-
-
-
-

Methods

- -
-

- listen​For​Devices() -

-
-
public func listenForDevices() -> AnyPublisher<[String: String], KukaiError>  
-
-
-

Start listening for ledger devices

- -
-

Returns

-

Publisher with a dictionary of [UUID: deviceName] or an KukaiError

- -
-
-

- stop​Listening() -

-
-
public func stopListening()  
-
-
-

Stop listening for and reporting new ledger devices found

- -
-
-
-

- connect​To(uuid:​) -

-
-
public func connectTo(uuid: String) -> AnyPublisher<Bool, KukaiError>  
-
-
-

Connect to a ledger device by a given UUID

- -
-

Returns

-

Publisher which will indicate true / false, or return an KukaiError if it can't connect to bluetooth

- -
-
-

- disconnect​From​Device() -

-
-
public func disconnectFromDevice()  
-
-
-

Disconnect from the current Ledger device

- -
-

Returns

-

A Publisher with a boolean, or KukaiError if soemthing goes wrong

- -
-
-

- get​Connected​Device​UUID() -

-
-
public func getConnectedDeviceUUID() -> String?  
-
-
-

Get the UUID of the connected device

- -
-

Returns

-

a string if it can be found

- -
-
-

- get​Address(for​Derivation​Path:​curve:​verify:​) -

-
-
public func getAddress(forDerivationPath derivationPath: String = HD.defaultDerivationPath, curve: EllipticalCurve = .ed25519, verify: Bool) -> AnyPublisher<(address: String, publicKey: String), KukaiError>  
-
-
-

Get a TZ address and public key from the current connected Ledger device

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
for​Derivation​PathString

Optional. The derivation path to use to extract the address from the underlying HD wallet

-
curveElliptical​Curve

Optional. The EllipticalCurve to use to extract the address

-
verifyBool

Whether or not to ask the ledger device to prompt the user to show them what the TZ address should be, to ensure the mobile matches

-
-

Returns

-

A publisher which will return a tuple containing the address and publicKey, or an KukaiError

- -
-
-

- sign(hex:​for​Derivation​Path:​parse:​) -

-
-
public func sign(hex: String, forDerivationPath derivationPath: String = HD.defaultDerivationPath, parse: Bool) -> AnyPublisher<String, KukaiError>   
-
-
-

Sign an operation payload with the underlying secret key, returning the signature

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
hexString

An operation converted to JSON, forged and watermarked, converted to a hex string. (Note: there are some issues with the ledger app signing batch transactions. May simply return no result at all. Can't run REVEAL and TRANSACTION together for example)

-
for​Derivation​PathString

Optional. The derivation path to use to extract the address from the underlying HD wallet

-
parseBool

Ledger can parse non-hashed (blake2b) hex data and display operation data to user (e.g. transfer 1 XTZ to TZ1abc, for fee: 0.001). There are many limitations around what can be parsed. Frequnetly it will require passing in false

-
-

Returns

-

A Publisher which will return a string containing the hex signature, or an KukaiError

- -
-
-

- central​Manager​Did​Update​State(_:​) -

-
-
public func centralManagerDidUpdateState(_ central: CBCentralManager)  
-
-
-

CBCentralManagerDelegate function, must be marked public because of protocol definition

- -
-
-
-

- central​Manager(_:​did​Discover:​advertisement​Data:​rssi:​) -

-
-
public func centralManager(_ central: CBCentralManager, didDiscover peripheral: CBPeripheral, advertisementData: [String : Any], rssi RSSI: NSNumber)  
-
-
-

CBCentralManagerDelegate function, must be marked public because of protocol definition

- -
-
-
-

- central​Manager(_:​did​Connect:​) -

-
-
public func centralManager(_ central: CBCentralManager, didConnect peripheral: CBPeripheral)  
-
-
-

CBCentralManagerDelegate function, must be marked public because of protocol definition

- -
-
-
-

- central​Manager(_:​did​Fail​ToConnect:​error:​) -

-
-
public func centralManager(_ central: CBCentralManager, didFailToConnect peripheral: CBPeripheral, error: Error?)  
-
-
-

CBCentralManagerDelegate function, must be marked public because of protocol definition

- -
-
-
-

- peripheral(_:​did​Discover​Services:​) -

-
-
public func peripheral(_ peripheral: CBPeripheral, didDiscoverServices error: Error?)  
-
-
-

CBCentralManagerDelegate function, must be marked public because of protocol definition

- -
-
-
-

- peripheral(_:​did​Discover​Characteristics​For:​error:​) -

-
-
public func peripheral(_ peripheral: CBPeripheral, didDiscoverCharacteristicsFor service: CBService, error: Error?)  
-
-
-

CBCentralManagerDelegate function, must be marked public because of protocol definition

- -
-
-
-

- peripheral(_:​did​Write​Value​For:​error:​) -

-
-
public func peripheral(_ peripheral: CBPeripheral, didWriteValueFor characteristic: CBCharacteristic, error: Error?)  
-
-
-

CBCentralManagerDelegate function, must be marked public because of protocol definition

- -
-
-
-

- peripheral(_:​did​Update​Value​For:​error:​) -

-
-
public func peripheral(_ peripheral: CBPeripheral, didUpdateValueFor characteristic: CBCharacteristic, error: Error?)  
-
-
-

CBCentralManagerDelegate function, must be marked public because of protocol definition

- -
-
-
- - - -
-
- - - - diff --git a/LedgerService_GeneralErrorCodes/index.html b/LedgerService_GeneralErrorCodes/index.html deleted file mode 100644 index b1f8bf95..00000000 --- a/LedgerService_GeneralErrorCodes/index.html +++ /dev/null @@ -1,404 +0,0 @@ - - - - - - KukaiCoreSwift - LedgerService.GeneralErrorCodes - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Ledger​Service.​General​Error​Codes -

- -
-
public enum GeneralErrorCodes: String, Error, Codable  
-
-
-

General Ledger error codes, pulled from the source, and some additional ones added for native swift issues

- -
-
- -
- - - - - - -%797 - - - -LedgerService.GeneralErrorCodes - - -LedgerService.GeneralErrorCodes - - - - - -String - -String - - - -LedgerService.GeneralErrorCodes->String - - - - - -Codable - -Codable - - - -LedgerService.GeneralErrorCodes->Codable - - - - - -Error - -Error - - - -LedgerService.GeneralErrorCodes->Error - - - - - - - - -
-

Member Of

-
-
LedgerService
-

A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

-
-
-

Conforms To

-
-
Codable
-
Error
-
String
-
-
-
-

Enumeration Cases

- -
-

- PIN_REMAINING_ATTEMPTS -

-
-
case PIN_REMAINING_ATTEMPTS = "63c0"
-
-
-
-

- INCORRECT_LENGTH -

-
-
case INCORRECT_LENGTH = "6700"
-
-
-
-

- MISSING_CRITICAL_PARAMETER -

-
-
case MISSING_CRITICAL_PARAMETER = "6800"
-
-
-
-

- COMMAND_INCOMPATIBLE_FILE_STRUCTURE -

-
-
case COMMAND_INCOMPATIBLE_FILE_STRUCTURE = "6981"
-
-
-
-

- SECURITY_STATUS_NOT_SATISFIED -

-
-
case SECURITY_STATUS_NOT_SATISFIED = "6982"
-
-
-
-

- CONDITIONS_OF_USE_NOT_SATISFIED -

-
-
case CONDITIONS_OF_USE_NOT_SATISFIED = "6985"
-
-
-
-

- INCORRECT_DATA -

-
-
case INCORRECT_DATA = "6a80"
-
-
-
-

- NOT_ENOUGH_MEMORY_SPACE -

-
-
case NOT_ENOUGH_MEMORY_SPACE = "6a84"
-
-
-
-

- REFERENCED_DATA_NOT_FOUND -

-
-
case REFERENCED_DATA_NOT_FOUND = "6a88"
-
-
-
-

- FILE_ALREADY_EXISTS -

-
-
case FILE_ALREADY_EXISTS = "6a89"
-
-
-
-

- INCORRECT_P1_P2 -

-
-
case INCORRECT_P1_P2 = "6b00"
-
-
-
-

- INS_NOT_SUPPORTED -

-
-
case INS_NOT_SUPPORTED = "6d00"
-
-
-
-

- CLA_NOT_SUPPORTED -

-
-
case CLA_NOT_SUPPORTED = "6e00"
-
-
-
-

- TECHNICAL_PROBLEM -

-
-
case TECHNICAL_PROBLEM = "6f00"
-
-
-
-

- MEMORY_PROBLEM -

-
-
case MEMORY_PROBLEM = "9240"
-
-
-
-

- NO_EF_SELECTED -

-
-
case NO_EF_SELECTED = "9400"
-
-
-
-

- INVALID_OFFSET -

-
-
case INVALID_OFFSET = "9402"
-
-
-
-

- FILE_NOT_FOUND -

-
-
case FILE_NOT_FOUND = "9404"
-
-
-
-

- INCONSISTENT_FILE -

-
-
case INCONSISTENT_FILE = "9408"
-
-
-
-

- ALGORITHM_NOT_SUPPORTED -

-
-
case ALGORITHM_NOT_SUPPORTED = "9484"
-
-
-
-

- INVALID_KCV -

-
-
case INVALID_KCV = "9485"
-
-
-
-

- CODE_NOT_INITIALIZED -

-
-
case CODE_NOT_INITIALIZED = "9802"
-
-
-
-

- ACCESS_CONDITION_NOT_FULFILLED -

-
-
case ACCESS_CONDITION_NOT_FULFILLED = "9804"
-
-
-
-

- CONTRADICTION_SECRET_CODE_STATUS -

-
-
case CONTRADICTION_SECRET_CODE_STATUS = "9808"
-
-
-
-

- CONTRADICTION_INVALIDATION -

-
-
case CONTRADICTION_INVALIDATION = "9810"
-
-
-
-

- CODE_BLOCKED -

-
-
case CODE_BLOCKED = "9840"
-
-
-
-

- MAX_VALUE_REACHED -

-
-
case MAX_VALUE_REACHED = "9850"
-
-
-
-

- GP_AUTH_FAILED -

-
-
case GP_AUTH_FAILED = "6300"
-
-
-
-

- LICENSING -

-
-
case LICENSING = "6f42"
-
-
-
-

- HALTED -

-
-
case HALTED = "6faa"
-
-
-
-

- DEVICE_LOCKED -

-
-
case DEVICE_LOCKED = "009000"
-
-
-
-

- UNKNOWN -

-
-
case UNKNOWN = "99999999"
-
-
-
-

- NO_WRITE_CHARACTERISTIC -

-
-
case NO_WRITE_CHARACTERISTIC = "99999996"
-
-
-
- - - -
-
- - - - diff --git a/LedgerService_TezosAppErrorCodes/index.html b/LedgerService_TezosAppErrorCodes/index.html deleted file mode 100644 index eaa7c521..00000000 --- a/LedgerService_TezosAppErrorCodes/index.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - KukaiCoreSwift - LedgerService.TezosAppErrorCodes - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Ledger​Service.​Tezos​App​Error​Codes -

- -
-
public enum TezosAppErrorCodes: String, Error, Codable  
-
-
-

Dedicated error codes pulled from the Ledger tezos app

- -
-
- -
- - - - - - -%35 - - - -LedgerService.TezosAppErrorCodes - - -LedgerService.TezosAppErrorCodes - - - - - -Error - -Error - - - -LedgerService.TezosAppErrorCodes->Error - - - - - -Codable - -Codable - - - -LedgerService.TezosAppErrorCodes->Codable - - - - - -String - -String - - - -LedgerService.TezosAppErrorCodes->String - - - - - - - - -
-

Member Of

-
-
LedgerService
-

A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

-
-
-

Conforms To

-
-
Codable
-
Error
-
String
-
-
-
-

Enumeration Cases

- -
-

- EXC_WRONG_PARAM -

-
-
case EXC_WRONG_PARAM = "6B00"
-
-
-
-

- EXC_WRONG_LENGTH -

-
-
case EXC_WRONG_LENGTH = "6C00"
-
-
-
-

- EXC_INVALID_INS -

-
-
case EXC_INVALID_INS = "6D00"
-
-
-
-

- EXC_WRONG_LENGTH_FOR_INS -

-
-
case EXC_WRONG_LENGTH_FOR_INS = "917E"
-
-
-
-

- EXC_REJECT -

-
-
case EXC_REJECT = "6985"
-
-
-
-

- EXC_PARSE_ERROR -

-
-
case EXC_PARSE_ERROR = "9405"
-
-
-
-

- EXC_REFERENCED_DATA_NOT_FOUND -

-
-
case EXC_REFERENCED_DATA_NOT_FOUND = "6A88"
-
-
-
-

- EXC_WRONG_VALUES -

-
-
case EXC_WRONG_VALUES = "6A80"
-
-
-
-

- EXC_SECURITY -

-
-
case EXC_SECURITY = "6982"
-
-
-
-

- EXC_HID_REQUIRED -

-
-
case EXC_HID_REQUIRED = "6983"
-
-
-
-

- EXC_CLASS -

-
-
case EXC_CLASS = "6E00"
-
-
-
-

- EXC_MEMORY_ERROR -

-
-
case EXC_MEMORY_ERROR = "9200"
-
-
-
- - - -
-
- - - - diff --git a/LedgerWallet/index.html b/LedgerWallet/index.html deleted file mode 100644 index 060d296c..00000000 --- a/LedgerWallet/index.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - KukaiCoreSwift - LedgerWallet - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Ledger​Wallet -

- -
-
public class LedgerWallet: Wallet  
-
-
-

A Tezos wallet class, used to cache infomration regarding the paired ledger device used to sign the payload. -This class can only be created by fetching data from a Ledger device and supplying this data to the constructor.

- -
-
-

It is not possible to call the async sign function of this class, it will return null. Signing with a ledger is a complicated async process. -Please use the LedgerService class to setup a bluetooth connection, connect to the device and request a payload signing.

- -
-
- -
- - - - - - -%437 - - - -LedgerWallet - - -LedgerWallet - - - - - -Wallet - - -Wallet - - - - - -LedgerWallet->Wallet - - - - - - - - -
-

Conforms To

-
-
Wallet
-

Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

-
-
-
-
-

Initializers

- -
-

- init?(address:​public​Key:​derivation​Path:​curve:​ledger​UUID:​) -

-
-
public init?(address: String, publicKey: String, derivationPath: String, curve: EllipticalCurve, ledgerUUID: String)  
-
-
-

Create an instance of a LedgerWallet. Can return nil if invalid public key supplied

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
addressString

The TZ address pulled from the Ledger device

-
public​KeyString

The hex string denoting the public key, pulled from the ledger device

-
derivation​PathString

The derivation path used to fetch the address / publicKey

-
curveElliptical​Curve

The elliptical curve used to fetch the address / public key

-
ledger​UUIDString

The unique Ledger UUID to identify the Ledger

-
-
-
-
-

Properties

- -
-

- type -

-
-
public var type = WalletType.ledger
-
-
-

The wallet type, hardcoded to always be WalletType.ledger

- -
-
-
-

- address -

-
-
public var address: String
-
-
-

The TZ address pulled from the Ledger device, cached to avoid complex retrieval when fetching balances etc.

- -
-
-
-

- public​Key -

-
-
public var publicKey: String
-
-
-

The raw hex public key extracted from the Ledger, needed in order to perform REVEAL operations

- -
-
-
-

- derivation​Path -

-
-
public var derivationPath: String
-
-
-

The derivation path used to fetch the address and public key

- -
-
-
-

- curve -

-
-
public var curve: EllipticalCurve
-
-
-

The elliptical curve used to fetch the address and public key

- -
-
-
-

- ledger​UUID -

-
-
public var ledgerUUID: String
-
-
-

The unique ledger UUID, that corresponds to this wallet address

- -
-
-
-
-

Methods

- -
-

- sign(_:​is​Operation:​completion:​) -

-
-
public func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))  
-
-
-

Sign a hex string. -If the string starts with "03" and is not 32 characters long, it will be treated as a watermarked operation and Ledger will be asked to parse + display the operation details. -Else it will be treated as an unknown operation and will simply display the Blake2b hash. -Please be careful when asking the Ledger to parse (passing in an operation), Ledgers have very limited display ability. Keep it to a single operation, not invoking a smart contract

- -
-
-
-

- private​Key​Curve() -

-
-
public func privateKeyCurve() -> EllipticalCurve  
-
-
-

Function to extract the curve used to create the public key

- -
-
-
-

- public​Key​Base58encoded() -

-
-
public func publicKeyBase58encoded() -> String  
-
-
-

Function to convert the public key into a Base58 encoded string

- -
-
-
- - - -
-
- - - - diff --git a/LiquidityBakingData/index.html b/LiquidityBakingData/index.html deleted file mode 100644 index c2aa0568..00000000 --- a/LiquidityBakingData/index.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - KukaiCoreSwift - LiquidityBakingData - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Liquidity​Baking​Data -

- -
-
public struct LiquidityBakingData: Codable  
-
-
-

Wrapper object to hold onto all the necessary data in order to work with liquidity baking contract (swap, add or remove liqudity)

- -
-
- -
- - - - - - -%279 - - - -LiquidityBakingData - - -LiquidityBakingData - - - - - -Codable - -Codable - - - -LiquidityBakingData->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- xtz​Pool -

-
-
public let xtzPool: XTZAmount
-
-
-

The total amount of XTZ in the contract

- -
-
-
-

- token​Pool -

-
-
public let tokenPool: TokenAmount
-
-
-

The total amount of the token in the contract (currently tzBTC)

- -
-
-
-

- total​Liquidity -

-
-
public let totalLiquidity: TokenAmount
-
-
-

The total amount of liquidity tokens in circulation

- -
-
-
-

- token​Contract​Address -

-
-
public let tokenContractAddress: String
-
-
-

The address of the dex contract

- -
-
-
-

- liquidity​Token​Contract​Address -

-
-
public let liquidityTokenContractAddress: String
-
-
-

The address of the liquidty token contract

- -
-
-
- - - -
-
- - - - diff --git a/LoggingConfig/index.html b/LoggingConfig/index.html deleted file mode 100644 index b450af49..00000000 --- a/LoggingConfig/index.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - KukaiCoreSwift - LoggingConfig - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Logging​Config -

- -
-
public struct LoggingConfig  
-
-
-

A struct to control what messages get logged

- -
- -
-

Methods

- -
-

- all​Off() -

-
-
public mutating func allOff()  
-
-
-

Turn off all logging

- -
-
-
-

- all​On() -

-
-
public mutating func allOn()  
-
-
-
- - - -
-
- - - - diff --git a/MediaProxyService/index.html b/MediaProxyService/index.html deleted file mode 100644 index a8e7d7c7..00000000 --- a/MediaProxyService/index.html +++ /dev/null @@ -1,592 +0,0 @@ - - - - - - KukaiCoreSwift - MediaProxyService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Media​Proxy​Service -

- -
-
public class MediaProxyService: NSObject  
-
-
-

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

- -
-
- -
- - - - - - -%775 - - - -MediaProxyService - - -MediaProxyService - - - - - -URLSessionDownloadDelegate - -URLSessionDownloadDelegate - - - -MediaProxyService->URLSessionDownloadDelegate - - - - - -NSObject - -NSObject - - - -MediaProxyService->NSObject - - - - - - - - -
-

Nested Types

-
-
MediaProxyService.Format
-

Enum denoting the avaialble sizes for media

-
-
MediaProxyService.Source
-

Supported source types for proxied media

-
-
MediaProxyService.MediaType
-

Supported media types

-
-
MediaProxyService.AggregatedMediaType
-

Helper to parse a collection of media types to understand its contents

-
-
-

Conforms To

-
-
NSObject
-
URLSessionDownloadDelegate
-
-
-
-

Methods

- -
-

- url(from​Uri​String:​of​Format:​keep​Gif:​) -

-
-
public static func url(fromUriString uri: String?, ofFormat format: Format, keepGif: Bool = false) -> URL?  
-
-
-

Take a URI from a token metadata response and convert it to a useable media proxy URL

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
from​Uri​StringString?

String containing a URI (supports IPFS URIs)

-
of​FormatFormat

The requested format from the proxy

-
-

Returns

-

An optional URL

- -
-
-

- url(from​Uri:​of​Format:​keep​Gif:​) -

-
-
public static func url(fromUri uri: URL?, ofFormat format: Format, keepGif: Bool = false) -> URL?  
-
-
-

Take a URI from a token metadata response and convert it to a useable media proxy URL

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
from​UriURL?

URL object containing a URI (supports IPFS URIs)

-
of​FormatFormat

The requested format from the proxy

-
-

Returns

-

An optional URL

- -
-
-

- thumbnail​URL(for​NFT:​keep​Gif:​) -

-
-
public static func thumbnailURL(forNFT nft: NFT, keepGif: Bool = false) -> URL?  
-
-
-

Helper method to return a standard thumbnail URL for a NFT, taking into account some custom logic / known workarounds

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​NFT

NFT object

-
-

Returns

-

An optional URL

- -
-
-

- display​URL(for​NFT:​keep​Gif:​) -

-
-
public static func displayURL(forNFT nft: NFT, keepGif: Bool = false) -> URL?  
-
-
-

Helper method to return a standard larger display URL for a NFT

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​NFT

NFT object

-
-

Returns

-

An optional URL

- -
-
-

- get​Media​Type(from​Formats:​) -

-
-
public static func getMediaType(fromFormats formats: [TzKTBalanceMetadataFormat]) -> [MediaType]  
-
-
-

Using only info from TzKTBalanceMetadataFormat determine the media type(s) of the object

- -
-
-
-

- get​Media​Type(from​Formats:​or​URL:​url​Session:​completion:​) -

-
-
public func getMediaType(fromFormats formats: [TzKTBalanceMetadataFormat], orURL url: URL?, urlSession: URLSession = .shared, completion: @escaping ((Result<[MediaType], KukaiError>) -> Void))  
-
-
-

Given multiple sources of information, attempt to find the media type the url is pointing too

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
from​Formats[TzKTBalance​Metadata​Format]

An array of TzKTBalanceMetadataFormat that comes down with the TzKTClient's balancing fetching code. It MAY contain infomration on the media type

-
or​URLURL?

The URL for the record. It MAY contain a file extension dennoting the file type

-
url​SessionURLSession

If type can't be found via URL or metadata, download the first packet, examine the headers for Content-Type using this session. (HEAD requests aren't currently supported if the asset hasn't been already cached)

-
completion@escaping ((Result<[Media​Type], Kukai​Error>) -> Void)

A block to run when a type can be found, or an error encountered

-
-
-
-

- types​Contents(_:​) -

-
-
public static func typesContents(_ types: [MediaType]) -> AggregatedMediaType?  
-
-
-

Helper method to parse an array of MediaType to quickly determine its content type so UI can be easily arraged

- -
-
-
-

- remove​All​Images(completion:​) -

-
-
public static func removeAllImages(completion: @escaping (() -> Void))  
-
-
-

Clear all images from all caches

- -
-
-
-

- remove​All​Images(from​Cache:​completion:​) -

-
-
public static func removeAllImages(fromCache: CacheType, completion: @escaping (() -> Void))  
-
-
-
-

- clear​Expired​Images() -

-
-
public static func clearExpiredImages()  
-
-
-

Clear only iamges from cahce that have expired

- -
-
-
-

- size​Of(cache:​) -

-
-
public static func sizeOf(cache: CacheType) -> UInt  
-
-
-

Get size in bytes

- -
-
-
-

- load(url:​to:​with​Cache​Type:​fallback:​down​Sample​Size:​completion:​) -

-
-
public static func load(url: URL?, to imageView: UIImageView, withCacheType cacheType: CacheType, fallback: UIImage, downSampleSize: CGSize? = nil, completion: ((CGSize?) -> Void)? = nil)  
-
-
-

Attempt to use KingFisher library to load an image from a URL, into an UIImageView, with support for downsampling, displaying loading spinner, svgs, gifs and the permanent / temporary caching system

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
urlURL?

Media proxy URL pointing to an image

-
toUIImage​View

The UIImageView to load the image into

-
from​Cache

Which cahce to search for the image, or load it into if not found and needs to be downloaded

-
fallbackUIImage

If an error occurs and an image can't be downloaded/loaded in, display this image instead

-
down​Sample​SizeCGSize?

Supply the dimensions you wish the image to be resized to fit

-
completion((CGSize?) -> Void)?

returns when operation finished, if successful it will return the downloaded image's CGSize

-
-
-
-

- image​Cache(for​Type:​) -

-
-
public static func imageCache(forType: CacheType) -> ImageCache  
-
-
-
-

- cache​Image(url:​cache​Type:​completion:​) -

-
-
public static func cacheImage(url: URL?, cacheType: CacheType = .temporary, completion: @escaping ((CGSize?) -> Void))  
-
-
-

Attempt to use KingFisher library to load an image from a URL, and store it directly in the cache for later usage. Also optional return the downloaded size via a completion block, useful for preparing table/collection view

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
urlURL?

Media proxy URL pointing to an image

-
from​Cache

Which cahce to search for the image, or load it into if not found and needs to be downloaded

-
completion@escaping ((CGSize?) -> Void)

returns when operation finished, if successful it will return the downloaded image's CGSize

-
-
-
-

- is​Cached(url:​cache​Type:​) -

-
-
public static func isCached(url: URL?, cacheType: CacheType = .temporary) -> Bool  
-
-
-

Check if a given url is already cached

- -
-
-
-

- size​For​Image​IfCached(url:​cache​Type:​completion:​) -

-
-
public static func sizeForImageIfCached(url: URL?, cacheType: CacheType = .temporary, completion: @escaping ((CGSize?) -> Void) )  
-
-
-

Check if an image is cached, and return its size if so. Useful for preparing table/collection view

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
urlURL?

Media proxy URL pointing to an image

-
from​Cache

Which cahce to search for the image, or load it into if not found and needs to be downloaded

-
completion@escaping ((CGSize?) -> Void)

returns when operation finished, if successful it will return the downloaded image's CGSize

-
-
-
-

- url​Session(_:​download​Task:​did​Finish​Downloading​To:​) -

-
-
public func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL)  
-
-
-
-

- url​Session(_:​task:​did​Complete​With​Error:​) -

-
-
public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?)  
-
-
-
-

- url​Session(_:​download​Task:​did​Write​Data:​total​Bytes​Written:​total​Bytes​Expected​ToWrite:​) -

-
-
public func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didWriteData bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64)  
-
-
-
- - - -
-
- - - - diff --git a/MediaProxyServiceError/index.html b/MediaProxyServiceError/index.html deleted file mode 100644 index 39405075..00000000 --- a/MediaProxyServiceError/index.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - KukaiCoreSwift - MediaProxyServiceError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Media​Proxy​Service​Error -

- -
-
public enum MediaProxyServiceError: String, Error  
-
-
- -
- - - - - - -%233 - - - -MediaProxyServiceError - - -MediaProxyServiceError - - - - - -String - -String - - - -MediaProxyServiceError->String - - - - - -Error - -Error - - - -MediaProxyServiceError->Error - - - - - - - - -
-

Conforms To

-
-
Error
-
String
-
-
-
-

Enumeration Cases

- -
-

- no​Mime​Type​Found​Inside​Formats -

-
-
case noMimeTypeFoundInsideFormats
-
-
-
-

- unable​ToParse​Content​Type -

-
-
case unableToParseContentType
-
-
-
- - - -
-
- - - - diff --git a/MediaProxyService_AggregatedMediaType/index.html b/MediaProxyService_AggregatedMediaType/index.html deleted file mode 100644 index c80b81db..00000000 --- a/MediaProxyService_AggregatedMediaType/index.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - KukaiCoreSwift - MediaProxyService.AggregatedMediaType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Media​Proxy​Service.​Aggregated​Media​Type -

- -
-
public enum AggregatedMediaType: String, Codable  
-
-
-

Helper to parse a collection of media types to understand its contents

- -
-
- -
- - - - - - -%569 - - - -MediaProxyService.AggregatedMediaType - - -MediaProxyService.AggregatedMediaType - - - - - -String - -String - - - -MediaProxyService.AggregatedMediaType->String - - - - - -Codable - -Codable - - - -MediaProxyService.AggregatedMediaType->Codable - - - - - - - - -
-

Member Of

-
-
MediaProxyService
-

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

-
-
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- image​Only -

-
-
case imageOnly
-
-
-
-

- audio​Only -

-
-
case audioOnly
-
-
-
-

- video​Only -

-
-
case videoOnly
-
-
-
-

- gif​Only -

-
-
case gifOnly
-
-
-
-

- image​And​Audio -

-
-
case imageAndAudio
-
-
-
- - - -
-
- - - - diff --git a/MediaProxyService_Format/index.html b/MediaProxyService_Format/index.html deleted file mode 100644 index 57b2cb5a..00000000 --- a/MediaProxyService_Format/index.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - KukaiCoreSwift - MediaProxyService.Format - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Media​Proxy​Service.​Format -

- -
-
public enum Format: String, Codable  
-
-
-

Enum denoting the avaialble sizes for media

- -
-
- -
- - - - - - -%297 - - - -MediaProxyService.Format - - -MediaProxyService.Format - - - - - -Codable - -Codable - - - -MediaProxyService.Format->Codable - - - - - -String - -String - - - -MediaProxyService.Format->String - - - - - - - - -
-

Member Of

-
-
MediaProxyService
-

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

-
-
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- icon -

-
-
case icon
-
-
-
-

- small -

-
-
case small
-
-
-
-

- medium -

-
-
case medium
-
-
-
-

- gallery -

-
-
case gallery
-
-
-
-

- raw -

-
-
case raw
-
-
-
- - - -
-
- - - - diff --git a/MediaProxyService_MediaType/index.html b/MediaProxyService_MediaType/index.html deleted file mode 100644 index 54054c87..00000000 --- a/MediaProxyService_MediaType/index.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - KukaiCoreSwift - MediaProxyService.MediaType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Media​Proxy​Service.​Media​Type -

- -
-
public enum MediaType: String, Codable  
-
-
-

Supported media types

- -
-
- -
- - - - - - -%431 - - - -MediaProxyService.MediaType - - -MediaProxyService.MediaType - - - - - -String - -String - - - -MediaProxyService.MediaType->String - - - - - -Codable - -Codable - - - -MediaProxyService.MediaType->Codable - - - - - - - - -
-

Member Of

-
-
MediaProxyService
-

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

-
-
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- image -

-
-
case image
-
-
-
-

- audio -

-
-
case audio
-
-
-
-

- video -

-
-
case video
-
-
-
-

- gif -

-
-
case gif
-
-
-
- - - -
-
- - - - diff --git a/MediaProxyService_Source/index.html b/MediaProxyService_Source/index.html deleted file mode 100644 index da641019..00000000 --- a/MediaProxyService_Source/index.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - KukaiCoreSwift - MediaProxyService.Source - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Media​Proxy​Service.​Source -

- -
-
public enum Source: String, Codable  
-
-
-

Supported source types for proxied media

- -
-
- -
- - - - - - -%75 - - - -MediaProxyService.Source - - -MediaProxyService.Source - - - - - -Codable - -Codable - - - -MediaProxyService.Source->Codable - - - - - -String - -String - - - -MediaProxyService.Source->String - - - - - - - - -
-

Member Of

-
-
MediaProxyService
-

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

-
-
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- ipfs -

-
-
case ipfs
-
-
-
-

- web -

-
-
case web
-
-
-
- - - -
-
- - - - diff --git a/NFT/index.html b/NFT/index.html deleted file mode 100644 index 10d9fbc8..00000000 --- a/NFT/index.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - KukaiCoreSwift - NFT - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - NFT -

- -
-
public struct NFT: Codable, Hashable  
-
-
-

An indiviual NFT (not the parent token/collection) holding a URI to an asset somewhere on the internet

- -
-
- -
- - - - - - -%289 - - - -NFT - - -NFT - - - - - -Identifiable - -Identifiable - - - -NFT->Identifiable - - - - - -Hashable - -Hashable - - - -NFT->Hashable - - - - - -Codable - -Codable - - - -NFT->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Hashable
-
Identifiable
-
-
-
-

Initializers

- -
-

- init(from​TzKTBalance:​) -

-
-
public init(fromTzKTBalance tzkt: TzKTBalance)  
-
-
-

Create a more developer friednly NFT from a generic TzKTBalance object

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​TzKTBalanceTzKTBalance

An instance of TzKTBalance containing data about an NFT

-
-
-
-
-

Properties

- -
-

- token​Id -

-
-
public let tokenId: Decimal
-
-
-

Each NFT of a token has a unique ID

- -
-
-
-

- duplicate​ID -

-
-
public var duplicateID: Int? = 0
-
-
-

In order to display in a tablview, the element must be hashable. But in cases where you want to show duplciates (e.g. recents), the computed hash needs to be slightly different -This property can be used as a quick hack a copy of the NFT struct slightly different, without affecting the data

- -
-
-
-

- parent​Contract -

-
-
public let parentContract: String
-
-
-

The address of the FA2 contract that created this NFT

- -
-
-
-

- parent​Alias -

-
-
public let parentAlias: String? 
-
-
-

The human readable alias of the parent contract (e.g. "Mooncakes")

- -
-
-
-

- fa​Version -

-
-
public let faVersion: FaVersion
-
-
-

The FaVersion of the token contrac

- -
-
-
-

- decimal​Places -

-
-
public var decimalPlaces: Int
-
-
-

Get the underlying number of decimal places that this token represents

- -
-
-
-

- balance -

-
-
public let balance: Decimal
-
-
-

Number of duplicate items of this NFT

- -
-
-
-

- name -

-
-
public let name: String
-
-
-

Human readbale name (e.g. "Tezos")

- -
-
-
-

- symbol -

-
-
public let symbol: String? 
-
-
-

Human readbale symbol (e.g. "XTZ")

- -
-
-
-

- `description` -

-
-
public let `description`: String
-
-
-

Human readable description (e.g. "This NFT was created too...")

- -
-
-
-

- artifact​URI -

-
-
public let artifactURI: URL? 
-
-
-

A URI to the asset the NFT is controlling ownership of

- -
-
-
-

- display​URI -

-
-
public let displayURI: URL? 
-
-
-

A URI used to display media of the artifact

- -
-
-
-

- thumbnail​URI -

-
-
public let thumbnailURI: URL? 
-
-
-

A smaller thumbnail used to display meda of the artifact

- -
-
-
-

- metadata -

-
-
public var metadata: TzKTBalanceMetadata? = nil
-
-
-

Metadata object containing useful information about the nft and its contents

- -
-
-
-

- is​Hidden -

-
-
public var isHidden: Bool = false
-
-
-

Recording if the user has marked the token as hidden

- -
-
-
-

- favourite​Sort​Index -

-
-
public var favouriteSortIndex: Int? = nil
-
-
-

Recording if the position the index the user chose for the favourite token to appear

- -
-
-
-

- is​Favourite -

-
-
public var isFavourite: Bool  
-
-
-
-

- id -

-
-
public var id: String  
-
-
-
-
-

Methods

- -
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-

Conforming to Hashable

- -
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: NFT, rhs: NFT) -> Bool  
-
-
-

Confomring to Equatable

- -
-
-
- - - -
-
- - - - diff --git a/NanoTez/index.html b/NanoTez/index.html deleted file mode 100644 index e4f5d845..00000000 --- a/NanoTez/index.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - KukaiCoreSwift - NanoTez - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Typealias - Nano​Tez -

- -
-
public typealias NanoTez = Int
-
-
-

typealias to make it clearer when we are using NanoTez, which only is only used for fee calcualtion

- -
-
-
- - - - diff --git a/NetworkConstants/index.html b/NetworkConstants/index.html deleted file mode 100644 index e4f93cc1..00000000 --- a/NetworkConstants/index.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - KukaiCoreSwift - NetworkConstants - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Network​Constants -

- -
-
public struct NetworkConstants: Codable  
-
-
-

The contants that a given Tezos node is using for block times, blakc size etc

- -
-
- -
- - - - - - -%271 - - - -NetworkConstants - - -NetworkConstants - - - - - -Codable - -Codable - - - -NetworkConstants->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- minimal_block_delay -

-
-
public let minimal_block_delay: String
-
-
-
-

- hard_gas_limit_per_operation -

-
-
public let hard_gas_limit_per_operation: String
-
-
-
-

- hard_gas_limit_per_block -

-
-
public let hard_gas_limit_per_block: String
-
-
-
-

- origination_size -

-
-
public let origination_size: Int
-
-
-
-

- cost_per_byte -

-
-
public let cost_per_byte: String
-
-
-
-

- hard_storage_limit_per_operation -

-
-
public let hard_storage_limit_per_operation: String
-
-
-
-
-

Methods

- -
-

- seconds​Between​Blocks() -

-
-
public func secondsBetweenBlocks() -> Int  
-
-
-
-

- mutez​Per​Byte() -

-
-
public func mutezPerByte() -> Int  
-
-
-
-

- xtz​Per​Byte() -

-
-
public func xtzPerByte() -> XTZAmount  
-
-
-
-

- max​Gas​Per​Operation() -

-
-
public func maxGasPerOperation() -> Int  
-
-
-
-

- max​Gas​Per​Block() -

-
-
public func maxGasPerBlock() -> Int  
-
-
-
-

- max​Storage​Per​Operation() -

-
-
public func maxStoragePerOperation() -> Int  
-
-
-
-

- bytes​For​Reveal() -

-
-
public func bytesForReveal() -> Int  
-
-
-
-

- xtz​For​Reveal() -

-
-
public func xtzForReveal() -> XTZAmount  
-
-
-
- - - -
-
- - - - diff --git a/NetworkService/index.html b/NetworkService/index.html deleted file mode 100644 index d5f1af6e..00000000 --- a/NetworkService/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - KukaiCoreSwift - NetworkService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Network​Service -

- -
-
public class NetworkService  
-
-
-

Class responsible for sending all the networking requests, checking for http errors, RPC errors, Decoding the responses and optionally logging progress

- -
-
- - -

Nested Types

-
-
NetworkService.NetworkError
-

Errors that can be returned by the NetworkService

-
-
-
-
-

Initializers

- -
-

- init(url​Session:​logging​Config:​) -

-
-
public init(urlSession: URLSession, loggingConfig: LoggingConfig)  
-
-
-

Init an NetworkService with a URLSession

- -
-

Parameters

- - - - - - - - - - - - - - - - -
url​SessionURLSession

A URLSession object

-
-
-
-
-

Properties

- -
-

- url​Session -

-
-
public let urlSession: URLSession
-
-
-

The URLSession used to preform all the networking operations

- -
-
-
-

- logging​Config -

-
-
public let loggingConfig: LoggingConfig
-
-
-

The URLSession used to preform all the networking operations

- -
-
-
-
-

Methods

- -
-

- send(rpc:​with​Base​URL:​completion:​) -

-
-
public func send<T: Decodable>(rpc: RPC<T>, withBaseURL baseURL: URL, completion: @escaping ((Result<T, KukaiError>) -> Void))  
-
-
-

A generic send function that takes an RPC, with a generic type conforming to Decodable, executes the request and returns the result.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
rpcRPC<T>

A instance of RPC.

-
with​Base​URLURL

The base URL needed. This will typically come from TezosNodeConfig.

-
completion@escaping ((Result<T, Kukai​Error>) -> Void)

A completion callback that will be executed on the main thread.

-
-

Returns

-

Void

- -
-
-

- request(url:​is​POST:​with​Body:​for​Return​Type:​completion:​) -

-
-
public func request<T: Decodable>(url: URL, isPOST: Bool, withBody body: Data?, forReturnType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void))  
-
-
-

A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response. -Using the Logging config, will auto log (or not) urls, response outputs, or fails to the console

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
urlURL

The full url, including query parameters to execute.

-
is​POSTBool

Bool indicating if its a POST or GET request.

-
with​BodyData?

Optional Data to be passed as the body.

-
for​Return​TypeT.​Type

The Type to parse the response as.

-
completion@escaping ((Result<T, Kukai​Error>) -> Void)

A completion block with a Result<T, Error> T being the supplied decoable type

-
-
-
-

- request(url:​is​POST:​with​Body:​for​Return​Type:​) -

-
-
public func request<T: Decodable>(url: URL, isPOST: Bool, withBody body: Data?, forReturnType: T.Type) -> AnyPublisher<T, KukaiError>  
-
-
-

A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response, returning it as a combine publisher. -Using the Logging config, will auto log (or not) urls, response outputs, or fails to the console

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
urlURL

The full url, including query parameters to execute.

-
is​POSTBool

Bool indicating if its a POST or GET request.

-
with​BodyData?

Optional Data to be passed as the body.

-
for​Return​TypeT.​Type

The Type to parse the response as.

-
-

Returns

-

A publisher of the supplied return type, or error response

- -
-
-

- log​Request​Failed(logging​Config:​is​Post:​full​URL:​payload:​error:​status​Code:​response​Data:​) -

-
-
public static func logRequestFailed(loggingConfig: LoggingConfig?, isPost: Bool, fullURL: URL, payload: Data?, error: Error?, statusCode: Int?, responseData: Data?)  
-
-
-

Logging details of request failures using os_log global logging

- -
-
-
-

- log​Request​Succeded(logging​Config:​is​Post:​full​URL:​payload:​response​Data:​) -

-
-
public static func logRequestSucceded(loggingConfig: LoggingConfig?, isPost: Bool, fullURL: URL, payload: Data?, responseData: Data?)  
-
-
-

Logging details of successful requests using os_log global logging

- -
-
-
-

- log​Request​Start(logging​Config:​full​URL:​) -

-
-
public static func logRequestStart(loggingConfig: LoggingConfig?, fullURL: URL)  
-
-
-

Logging details when a request starts using os_log global logging

- -
-
-
- - - -
-
- - - - diff --git a/NetworkService_NetworkError/index.html b/NetworkService_NetworkError/index.html deleted file mode 100644 index 26e01f00..00000000 --- a/NetworkService_NetworkError/index.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - KukaiCoreSwift - NetworkService.NetworkError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Network​Service.​Network​Error -

- -
-
public enum NetworkError: Error  
-
-
-

Errors that can be returned by the NetworkService

- -
-
- -
- - - - - - -%423 - - - -NetworkService.NetworkError - - -NetworkService.NetworkError - - - - - -Error - -Error - - - -NetworkService.NetworkError->Error - - - - - - - - -
-

Member Of

-
-
NetworkService
-

Class responsible for sending all the networking requests, checking for http errors, RPC errors, Decoding the responses and optionally logging progress

-
-
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- parse -

-
-
case parse(error: String) 
-
-
-
-

- invalid​URL -

-
-
case invalidURL
-
-
-
-

- unknown -

-
-
case unknown
-
-
-
-

- http​Error -

-
-
case httpError(statusCode: Int, response: String?) 
-
-
-
- - - -
-
- - - - diff --git a/NetworkVersion/index.html b/NetworkVersion/index.html deleted file mode 100644 index 45798ddb..00000000 --- a/NetworkVersion/index.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - KukaiCoreSwift - NetworkVersion - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Network​Version -

- -
-
public struct NetworkVersion: Codable  
-
-
-

The version of the Tezos code being run by the given node

- -
-
- -
- - - - - - -%303 - - - -NetworkVersion - - -NetworkVersion - - - - - -Codable - -Codable - - - -NetworkVersion->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- chain​Name_mainnet -

-
-
public static let chainName_mainnet = "mainnet"
-
-
-
-
-

Methods

- -
-

- chain​Name() -

-
-
public func chainName() -> String  
-
-
-
-

- is​Mainnet() -

-
-
public func isMainnet() -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/NilOnDecodingError/index.html b/NilOnDecodingError/index.html deleted file mode 100644 index 91173428..00000000 --- a/NilOnDecodingError/index.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - KukaiCoreSwift - NilOnDecodingError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Nil​OnDecoding​Error -

- -
-
@propertyWrapper
-public struct NilOnDecodingError<Wrapped>  
-
-
-

property wrapper to easily handle a situation where we don't want decoding to fail for 1 property which may be problematic. Instead just default it to nil

- -
-
- -
- - - - - - -%25 - - - -NilOnDecodingError - - -NilOnDecodingError - - - - - -Encodable - -Encodable - - - -NilOnDecodingError->Encodable - - - - - -Decodable - -Decodable - - - -NilOnDecodingError->Decodable - - - - - - - - -
-

Conforms To

-
-
Decodable
-
Encodable
-
-
-
-

Initializers

- -
-

- init(wrapped​Value:​) -

-
-
public init(wrappedValue: Wrapped?)  
-
-
-
-
-

Properties

- -
-

- wrapped​Value -

-
-
public var wrappedValue: Wrapped? 
-
-
-
- - - -
-
- - - - diff --git a/ObjktAttribute/index.html b/ObjktAttribute/index.html deleted file mode 100644 index 6b238ab8..00000000 --- a/ObjktAttribute/index.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktAttribute - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Attribute -

- -
-
public struct ObjktAttribute: Codable  
-
-
- -
- - - - - - -%155 - - - -ObjktAttribute - - -ObjktAttribute - - - - - -Codable - -Codable - - - -ObjktAttribute->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- attribute -

-
-
public let attribute: ObjktAttributeData
-
-
-
- - - -
-
- - - - diff --git a/ObjktAttributeCounts/index.html b/ObjktAttributeCounts/index.html deleted file mode 100644 index 5fabf2a6..00000000 --- a/ObjktAttributeCounts/index.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktAttributeCounts - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Attribute​Counts -

- -
-
public struct ObjktAttributeCounts: Codable  
-
-
- -
- - - - - - -%311 - - - -ObjktAttributeCounts - - -ObjktAttributeCounts - - - - - -Codable - -Codable - - - -ObjktAttributeCounts->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- editions -

-
-
public let editions: Decimal
-
-
-
- - - -
-
- - - - diff --git a/ObjktAttributeData/index.html b/ObjktAttributeData/index.html deleted file mode 100644 index d285eee3..00000000 --- a/ObjktAttributeData/index.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktAttributeData - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Attribute​Data -

- -
-
public struct ObjktAttributeData: Codable  
-
-
- -
- - - - - - -%159 - - - -ObjktAttributeData - - -ObjktAttributeData - - - - - -Codable - -Codable - - - -ObjktAttributeData->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- name -

-
-
public let name: String
-
-
-
-

- value -

-
-
public let value: String
-
-
-
-

- attribute_counts -

-
-
public let attribute_counts: [ObjktAttributeCounts] 
-
-
-
- - - -
-
- - - - diff --git a/ObjktClient/index.html b/ObjktClient/index.html deleted file mode 100644 index e20f88ab..00000000 --- a/ObjktClient/index.html +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktClient - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Objkt​Client -

- -
-
public class ObjktClient  
-
-
-

Client for interacting with the API of the popular NFT marketplace, OBJKT.com -Client exposes functions for fetching metadata, pricing, purchase offers, listing etc

- -
- -
-

Initializers

- -
-

- init(network​Service:​config:​) -

-
-
public init(networkService: NetworkService, config: TezosNodeClientConfig)  
-
-
-

Init a ObjktClient with a NetworkService and a TezosNodeClientConfig.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
network​ServiceNetwork​Service

NetworkService used to manage network communication.

-
configTezos​Node​Client​Config

TezosNodeClientConfig used to apss in settings.

-
-
-
-
-

Properties

- -
-

- collections -

-
-
public var collections: [String: ObjktCollection] 
-
-
-

Cached metadata of NFT collections, e.g. name, thumbnailURL etc

- -
-
-
-

- tokens -

-
-
public var tokens: [String: ObjktTokenReponse] 
-
-
-

Cached metadata of specific tokens, e.g. prices, offers etc

- -
-
-
-
-

Methods

- -
-

- unresolved​Collections(addresses:​) -

-
-
public func unresolvedCollections(addresses: [String]) -> [String]  
-
-
-

Take in an array of contract addresses, and return a list of the ones that we currently have no metadata for

- -
-
-
-

- resolve​Collections​All(addresses:​completion:​) -

-
-
public func resolveCollectionsAll(addresses: [String], completion: @escaping ((Result<Bool, KukaiError>) -> Void))  
-
-
-

Search OBJKT to find metadata on the list of addresses provided

- -
-
-
-

- resolve​Collections​Page(addresses:​completion:​) -

-
-
public func resolveCollectionsPage(addresses: ArraySlice<String>, completion: @escaping ((Result<GraphQLResponse<ObjktCollections>, KukaiError>) -> Void))  
-
-
-

Find the metadata of a list of contracts, used recurrisvely to find all collections while limited to request query size

- -
-
-
-

- resolve​Token(address:​token​Id:​for​Owner​Wallet​Address:​completion:​) -

-
-
public func resolveToken(address: String, tokenId: Decimal, forOwnerWalletAddress walletAddress: String, completion: @escaping ((Result<GraphQLResponse<ObjktTokenReponse>, KukaiError>) -> Void))  
-
-
-

Find the meatdata of a specific token

- -
-
-
-

- token​Response(for​Address:​token​Id:​) -

-
-
public func tokenResponse(forAddress: String, tokenId: Int) -> ObjktTokenReponse?  
-
-
-

Helper to fetch a specific token metadata from the cache

- -
-
-
-

- delete​Cache() -

-
-
public func deleteCache()  
-
-
-

Clear all the cached data

- -
-
-
- - - -
-
- - - - diff --git a/ObjktCollection/index.html b/ObjktCollection/index.html deleted file mode 100644 index 7be561e2..00000000 --- a/ObjktCollection/index.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktCollection - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Collection -

- -
-
public struct ObjktCollection: Codable  
-
-
-

Single collection item

- -
-
- -
- - - - - - -%633 - - - -ObjktCollection - - -ObjktCollection - - - - - -Codable - -Codable - - - -ObjktCollection->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- contract -

-
-
public let contract: String
-
-
-
-

- name -

-
-
public let name: String? 
-
-
- -
-

- floor_price -

-
-
public let floor_price: Decimal? 
-
-
-
-

- twitter -

-
-
public let twitter: String? 
-
-
-
-

- website -

-
-
public let website: String? 
-
-
-
-

- owners -

-
-
public let owners: Decimal? 
-
-
-
-

- editions -

-
-
public let editions: Decimal? 
-
-
-
-

- creator -

-
-
public let creator: ObjktCreator? 
-
-
-
-
-

Methods

- -
-

- website​URL() -

-
-
public func websiteURL() -> URL?  
-
-
-
-

- twitter​URL() -

-
-
public func twitterURL() -> URL?  
-
-
-
-

- floor​Price() -

-
-
public func floorPrice() -> XTZAmount?  
-
-
-
- - - -
-
- - - - diff --git a/ObjktCollections/index.html b/ObjktCollections/index.html deleted file mode 100644 index e43718b7..00000000 --- a/ObjktCollections/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktCollections - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Collections -

- -
-
public struct ObjktCollections: Codable  
-
-
-

GarpQL bulk response for a group of collections

- -
-
- -
- - - - - - -%81 - - - -ObjktCollections - - -ObjktCollections - - - - - -Codable - -Codable - - - -ObjktCollections->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- fa -

-
-
public let fa: [ObjktCollection] 
-
-
-
- - - -
-
- - - - diff --git a/ObjktCreator/index.html b/ObjktCreator/index.html deleted file mode 100644 index 0148ac98..00000000 --- a/ObjktCreator/index.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktCreator - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Creator -

- -
-
public struct ObjktCreator: Codable  
-
-
- -
- - - - - - -%683 - - - -ObjktCreator - - -ObjktCreator - - - - - -Codable - -Codable - - - -ObjktCreator->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- address -

-
-
public let address: String? 
-
-
-
-

- alias -

-
-
public let alias: String? 
-
-
-
-

- webiste -

-
-
public let webiste: String? 
-
-
-
-

- twitter -

-
-
public let twitter: String? 
-
-
-
- - - -
-
- - - - diff --git a/ObjktEvent/index.html b/ObjktEvent/index.html deleted file mode 100644 index 0167f2f1..00000000 --- a/ObjktEvent/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktEvent - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Event -

- -
-
public struct ObjktEvent: Codable  
-
-
-

Single event item

- -
-
- -
- - - - - - -%743 - - - -ObjktEvent - - -ObjktEvent - - - - - -Codable - -Codable - - - -ObjktEvent->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- price_xtz -

-
-
public let price_xtz: Decimal? 
-
-
-
- - - -
-
- - - - diff --git a/ObjktFa/index.html b/ObjktFa/index.html deleted file mode 100644 index 3d89a1fe..00000000 --- a/ObjktFa/index.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktFa - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Fa -

- -
-
public struct ObjktFa: Codable  
-
-
-

Single FA item

- -
-
- -
- - - - - - -%471 - - - -ObjktFa - - -ObjktFa - - - - - -Codable - -Codable - - - -ObjktFa->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- editions -

-
-
public let editions: Decimal? 
-
-
-
-

- floor_price -

-
-
public let floor_price: Decimal? 
-
-
-
- - - -
-
- - - - diff --git a/ObjktListing/index.html b/ObjktListing/index.html deleted file mode 100644 index ff8acbfd..00000000 --- a/ObjktListing/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktListing - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Listing -

- -
-
public struct ObjktListing: Codable  
-
-
- -
- - - - - - -%765 - - - -ObjktListing - - -ObjktListing - - - - - -Codable - -Codable - - - -ObjktListing->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- seller_address -

-
-
public let seller_address: String? 
-
-
-
-

- price_xtz -

-
-
public let price_xtz: Decimal? 
-
-
-
- - - -
-
- - - - diff --git a/ObjktSale/index.html b/ObjktSale/index.html deleted file mode 100644 index 7aa36135..00000000 --- a/ObjktSale/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktSale - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Sale -

- -
-
public struct ObjktSale: Codable  
-
-
- -
- - - - - - -%343 - - - -ObjktSale - - -ObjktSale - - - - - -Codable - -Codable - - - -ObjktSale->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- price_xtz -

-
-
public let price_xtz: Decimal? 
-
-
-
-

- timestamp -

-
-
public let timestamp: String? 
-
-
-
- - - -
-
- - - - diff --git a/ObjktToken/index.html b/ObjktToken/index.html deleted file mode 100644 index 2d4dc9f0..00000000 --- a/ObjktToken/index.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktToken - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Token -

- -
-
public struct ObjktToken: Codable  
-
-
-

Single token item

- -
-
- -
- - - - - - -%711 - - - -ObjktToken - - -ObjktToken - - - - - -Codable - -Codable - - - -ObjktToken->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- highest_offer -

-
-
public let highest_offer: Decimal? 
-
-
-
-

- lowest_ask -

-
-
public let lowest_ask: Decimal? 
-
-
-
-

- metadata -

-
-
public let metadata: String? 
-
-
-
-

- name -

-
-
public let name: String? 
-
-
-
-

- attributes -

-
-
public let attributes: [ObjktAttribute] 
-
-
-
-

- listing_sales -

-
-
public let listing_sales: [ObjktSale] 
-
-
-
-

- listings_active -

-
-
public let listings_active: [ObjktListing] 
-
-
-
- - - -
-
- - - - diff --git a/ObjktTokenReponse/index.html b/ObjktTokenReponse/index.html deleted file mode 100644 index e6795b23..00000000 --- a/ObjktTokenReponse/index.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - KukaiCoreSwift - ObjktTokenReponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Objkt​Token​Reponse -

- -
-
public struct ObjktTokenReponse: Codable  
-
-
-

GarpQL response for required data for a given token

- -
-
- -
- - - - - - -%123 - - - -ObjktTokenReponse - - -ObjktTokenReponse - - - - - -Codable - -Codable - - - -ObjktTokenReponse->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- token -

-
-
public let token: [ObjktToken] 
-
-
-
-

- event -

-
-
public let event: [ObjktEvent] 
-
-
-
-

- fa -

-
-
public let fa: [ObjktFa] 
-
-
-
-
-

Methods

- -
-

- is​OnSale() -

-
-
public func isOnSale() -> Bool  
-
-
-
-

- on​Sale​Price() -

-
-
public func onSalePrice() -> XTZAmount?  
-
-
-
-

- last​Sale​Price() -

-
-
public func lastSalePrice() -> XTZAmount?  
-
-
-
-

- floor​Price() -

-
-
public func floorPrice() -> XTZAmount?  
-
-
-
- - - -
-
- - - - diff --git a/OfflineConstants/index.html b/OfflineConstants/index.html deleted file mode 100644 index 05b860df..00000000 --- a/OfflineConstants/index.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - KukaiCoreSwift - OfflineConstants - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Offline​Constants -

- -
-
public struct OfflineConstants  
-
- - - - - -
-
- - - - diff --git a/Operation/index.html b/Operation/index.html deleted file mode 100644 index 64648085..00000000 --- a/Operation/index.html +++ /dev/null @@ -1,486 +0,0 @@ - - - - - - KukaiCoreSwift - Operation - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation -

- -
-
public class Operation: Codable  
-
-
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

- -
-
- -
- - - - - - -%479 - - - -Operation - - -Operation - - - - - -Codable - -Codable - - - -Operation->Codable - - - - - -OperationActivateAccount - - -OperationActivateAccount - - - - - -OperationActivateAccount->Operation - - - - - -OperationSeedNonceRevelation - - -OperationSeedNonceRevelation - - - - - -OperationSeedNonceRevelation->Operation - - - - - -OperationTransaction - - -OperationTransaction - - - - - -OperationTransaction->Operation - - - - - -OperationDoubleEndorsementEvidence - - -OperationDoubleEndorsementEvidence - - - - - -OperationDoubleEndorsementEvidence->Operation - - - - - -OperationDelegation - - -OperationDelegation - - - - - -OperationDelegation->Operation - - - - - -OperationEndorsement - - -OperationEndorsement - - - - - -OperationEndorsement->Operation - - - - - -OperationOrigination - - -OperationOrigination - - - - - -OperationOrigination->Operation - - - - - -OperationBallot - - -OperationBallot - - - - - -OperationBallot->Operation - - - - - -OperationDoubleBakingEvidence - - -OperationDoubleBakingEvidence - - - - - -OperationDoubleBakingEvidence->Operation - - - - - -OperationReveal - - -OperationReveal - - - - - -OperationReveal->Operation - - - - - -OperationProposals - - -OperationProposals - - - - - -OperationProposals->Operation - - - - - - - - -
-

Subclasses

-
-
OperationActivateAccount
-

Operation subclass for revealing a publickey to the network.

-
-
OperationBallot
-

Operation to submit a ballot on an upcoming proposal

-
-
OperationDelegation
-

Operation subclass for delegating an account to a baker

-
-
OperationDoubleBakingEvidence
-

Operation to report a baking of baking the same block twice

-
-
OperationDoubleEndorsementEvidence
-

Operation to report a baker trying to endorse a block twice

-
-
OperationEndorsement
-

Operation for endorsing a block

-
-
OperationOrigination
-

Operation subclass for originating a contract on the Tezos network

-
-
OperationProposals
-
-
OperationReveal
-

Operation subclass for revealing a publickey to the network.

-
-
OperationSeedNonceRevelation
-

Operation to reveal seed nonce to blockchain

-
-
OperationTransaction
-

Operation subclass for sending XTZ to a destination

-
-
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(operation​Kind:​source:​) -

-
-
public init(operationKind: OperationKind, source: String)  
-
-
-

Create a base operation.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
operation​KindOperation​Kind

The type of operation.

-
sourceString

The address of the acocunt sending the operation.

-
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-

Create a base operation.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
fromDecoder

A decoder used to convert a data fromat (such as JSON) into the model object.

-
-
-
-
-

Properties

- -
-

- operation​Kind -

-
-
public let operationKind: OperationKind
-
-
-

An enum to denote the type of operation. e.g. transaction, delegation, reveal etc.

- -
-
-
-

- source -

-
-
public var source: String? 
-
-
-

The source address for the operation

- -
-
-
-

- counter -

-
-
public var counter: String? = "0"
-
-
-

A string representing a numeric counter. Must be unique and 1 higher than the previous counter. Current counter obtained from the metadata query in TezosNodeClient

- -
-
-
-

- operation​Fees -

-
-
public var operationFees: OperationFees  
-
-
-

Object representing the various fees, storage and compute required to fulfil this operation

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public func encode(to encoder: Encoder) throws  
-
-
-

Convert the object into a data format, such as JSON.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
toEncoder

An encoder that will allow conversions to multipel data formats.

-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: Operation) -> Bool  
-
-
-

A function to check if two operations are equal.

- -
-
-
    -
  • -

    parameter _: An Operation to compare against

    -
  • -
- -
-

Returns

-

A Bool indicating the result.

- -
-
- - - -
-
- - - - diff --git a/OperationActivateAccount/index.html b/OperationActivateAccount/index.html deleted file mode 100644 index 981b4ffa..00000000 --- a/OperationActivateAccount/index.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - KukaiCoreSwift - OperationActivateAccount - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Activate​Account -

- -
-
public class OperationActivateAccount: Operation  
-
-
-

Operation subclass for revealing a publickey to the network.

- -
-
- -
- - - - - - -%43 - - - -OperationActivateAccount - - -OperationActivateAccount - - - - - -Operation - - -Operation - - - - - -OperationActivateAccount->Operation - - - - - - - - -
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(wallet:​and​Secret:​) -

-
-
public init(wallet: Wallet, andSecret: String)  
-
-
-

Create an OperationActivateAccount.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
walletWallet

The Wallet object, whose publicKey will be used to activate on the network

-
and​SecretString

The secret supplied in JSON file

-
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-

Create a base operation.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
fromDecoder

A decoder used to convert a data fromat (such as JSON) into the model object.

-
-
-
-
-

Properties

- -
-

- public​Key -

-
-
public let publicKey: String
-
-
-
-

- secret -

-
-
public let secret: String
-
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-

Convert the object into a data format, such as JSON.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
toEncoder

An encoder that will allow conversions to multipel data formats.

-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationActivateAccount) -> Bool  
-
-
-

A function to check if two operations are equal.

- -
-
-
    -
  • -

    parameter _: An Operation to compare against

    -
  • -
- -
-

Returns

-

A Bool indicating the result.

- -
-
- - - -
-
- - - - diff --git a/OperationBallot/index.html b/OperationBallot/index.html deleted file mode 100644 index 87c2f411..00000000 --- a/OperationBallot/index.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - KukaiCoreSwift - OperationBallot - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Ballot -

- -
-
public class OperationBallot: Operation  
-
-
-

Operation to submit a ballot on an upcoming proposal

- -
-
- -
- - - - - - -%785 - - - -OperationBallot - - -OperationBallot - - - - - -Operation - - -Operation - - - - - -OperationBallot->Operation - - - - - - - - -
-

Nested Types

-
-
OperationBallot.Ballot
-

Enum matching the available ballot options

-
-
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(wallet:​period:​proposal:​ballot:​) -

-
-
public init(wallet: Wallet, period: Int, proposal: String, ballot: Ballot)  
-
-
-

Init with wallet, period, proposal and ballot

- -
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- period -

-
-
public let period: Int
-
-
-

The voting period

- -
-
-
-

- proposal -

-
-
public let proposal: String
-
-
-

The identifier of the proposa;

- -
-
-
-

- ballot -

-
-
public let ballot: Ballot
-
-
-

The wallet holders vote

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationBallot) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/OperationBallot_Ballot/index.html b/OperationBallot_Ballot/index.html deleted file mode 100644 index 4490ed1b..00000000 --- a/OperationBallot_Ballot/index.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - KukaiCoreSwift - OperationBallot.Ballot - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Operation​Ballot.​Ballot -

- -
-
public enum Ballot: String, Codable  
-
-
-

Enum matching the available ballot options

- -
-
- -
- - - - - - -%91 - - - -OperationBallot.Ballot - - -OperationBallot.Ballot - - - - - -Codable - -Codable - - - -OperationBallot.Ballot->Codable - - - - - -String - -String - - - -OperationBallot.Ballot->String - - - - - - - - -
-

Member Of

-
-
OperationBallot
-

Operation to submit a ballot on an upcoming proposal

-
-
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- nay -

-
-
case nay
-
-
-
-

- yay -

-
-
case yay
-
-
-
-

- pass -

-
-
case pass
-
-
-
- - - -
-
- - - - diff --git a/OperationBlockHeader/index.html b/OperationBlockHeader/index.html deleted file mode 100644 index 23196d8d..00000000 --- a/OperationBlockHeader/index.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - KukaiCoreSwift - OperationBlockHeader - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Block​Header -

- -
-
public struct OperationBlockHeader: Codable, Equatable  
-
-
- -
- - - - - - -%615 - - - -OperationBlockHeader - - -OperationBlockHeader - - - - - -Codable - -Codable - - - -OperationBlockHeader->Codable - - - - - -Equatable - -Equatable - - - -OperationBlockHeader->Equatable - - - - - - - - -
-

Nested Types

-
-
OperationBlockHeader.CodingKeys
-
-
-

Conforms To

-
-
Codable
-
Equatable
-
-
-
-

Initializers

- -
-

- init(level:​proto:​predecessor:​timestamp:​validation​Pass:​operations​Hash:​fitness:​context:​priority:​proof​OfWork​Nonce:​seed​Nonce​Hash:​signature:​) -

-
-
public init(level: Int, proto: Int, predecessor: String, timestamp: Date, validationPass: Int, operationsHash: String, fitness: [String], context: String, priority: Int, proofOfWorkNonce: String, seedNonceHash: String?, signature: String)  
-
-
-
-

- init(from:​) -

-
-
public init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- level -

-
-
public let level: Int
-
-
-
-

- proto -

-
-
public let proto: Int
-
-
-
-

- predecessor -

-
-
public let predecessor: String
-
-
-
-

- timestamp -

-
-
public let timestamp: Date
-
-
-
-

- validation​Pass -

-
-
public let validationPass: Int
-
-
-
-

- operations​Hash -

-
-
public let operationsHash: String
-
-
-
-

- fitness -

-
-
public let fitness: [String] 
-
-
-
-

- context -

-
-
public let context: String
-
-
-
-

- priority -

-
-
public let priority: Int
-
-
-
-

- proof​OfWork​Nonce -

-
-
public let proofOfWorkNonce: String
-
-
-
-

- seed​Nonce​Hash -

-
-
public let seedNonceHash: String? 
-
-
-
-

- signature -

-
-
public let signature: String
-
-
-
- - - -
-
- - - - diff --git a/OperationBlockHeader_CodingKeys/index.html b/OperationBlockHeader_CodingKeys/index.html deleted file mode 100644 index bec9dc4a..00000000 --- a/OperationBlockHeader_CodingKeys/index.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - KukaiCoreSwift - OperationBlockHeader.CodingKeys - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Operation​Block​Header.​Coding​Keys -

- -
-
public enum CodingKeys: String, CodingKey  
-
-
- -
- - - - - - -%197 - - - -OperationBlockHeader.CodingKeys - - -OperationBlockHeader.CodingKeys - - - - - -CodingKey - -CodingKey - - - -OperationBlockHeader.CodingKeys->CodingKey - - - - - -String - -String - - - -OperationBlockHeader.CodingKeys->String - - - - - - - - -
-

Member Of

-
-
OperationBlockHeader
-
-
-

Conforms To

-
-
CodingKey
-
String
-
-
-
-

Enumeration Cases

- -
-

- level -

-
-
case level
-
-
-
-

- proto -

-
-
case proto
-
-
-
-

- predecessor -

-
-
case predecessor
-
-
-
-

- timestamp -

-
-
case timestamp
-
-
-
-

- validation​Pass -

-
-
case validationPass = "validation_pass"
-
-
-
-

- operations​Hash -

-
-
case operationsHash = "operations_hash"
-
-
-
-

- fitness -

-
-
case fitness
-
-
-
-

- context -

-
-
case context
-
-
-
-

- priority -

-
-
case priority
-
-
-
-

- proof​OfWork​Nonce -

-
-
case proofOfWorkNonce = "proof_of_work_nonce"
-
-
-
-

- seed​Nonce​Hash -

-
-
case seedNonceHash = "seed_nonce_hash"
-
-
-
-

- signature -

-
-
case signature
-
-
-
- - - -
-
- - - - diff --git a/OperationDelegation/index.html b/OperationDelegation/index.html deleted file mode 100644 index 2a6de00f..00000000 --- a/OperationDelegation/index.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - KukaiCoreSwift - OperationDelegation - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Delegation -

- -
-
public class OperationDelegation: Operation  
-
-
-

Operation subclass for delegating an account to a baker

- -
-
- -
- - - - - - -%347 - - - -OperationDelegation - - -OperationDelegation - - - - - -Operation - - -Operation - - - - - -OperationDelegation->Operation - - - - - - - - -
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(source:​delegate:​) -

-
-
public init(source: String, delegate: String?)  
-
-
-

Create an OperationDelegation.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
sourceString

The address of the acocunt sending the operation.

-
delegateString?

Optional. The address of the baker to delegate to, or nil to undelegate the source address.

-
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-

Create a base operation.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
fromDecoder

A decoder used to convert a data fromat (such as JSON) into the model object.

-
-
-
-
-

Properties

- -
-

- delegate -

-
-
public let delegate: String? 
-
-
-

The baker to delegate too, or nil to undelegate

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-

Convert the object into a data format, such as JSON.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
toEncoder

An encoder that will allow conversions to multipel data formats.

-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationDelegation) -> Bool  
-
-
-

A function to check if two operations are equal.

- -
-
-
    -
  • -

    parameter _: An Operation to compare against

    -
  • -
- -
-

Returns

-

A Bool indicating the result.

- -
-
- - - -
-
- - - - diff --git a/OperationDoubleBakingEvidence/index.html b/OperationDoubleBakingEvidence/index.html deleted file mode 100644 index f49320d6..00000000 --- a/OperationDoubleBakingEvidence/index.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - KukaiCoreSwift - OperationDoubleBakingEvidence - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Double​Baking​Evidence -

- -
-
public class OperationDoubleBakingEvidence: Operation  
-
-
-

Operation to report a baking of baking the same block twice

- -
-
- -
- - - - - - -%101 - - - -OperationDoubleBakingEvidence - - -OperationDoubleBakingEvidence - - - - - -Operation - - -Operation - - - - - -OperationDoubleBakingEvidence->Operation - - - - - - - - -
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(wallet:​bh1:​bh2:​) -

-
-
public init(wallet: Wallet, bh1: OperationBlockHeader, bh2: OperationBlockHeader)  
-
-
-

Init with wallet and two block headers

- -
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- bh1 -

-
-
public let bh1: OperationBlockHeader
-
-
-

The block header of the first baked block

- -
-
-
-

- bh2 -

-
-
public let bh2: OperationBlockHeader
-
-
-

The block header of the second baked block

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationDoubleBakingEvidence) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/OperationDoubleEndorsementEvidence/index.html b/OperationDoubleEndorsementEvidence/index.html deleted file mode 100644 index 5388fee3..00000000 --- a/OperationDoubleEndorsementEvidence/index.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - KukaiCoreSwift - OperationDoubleEndorsementEvidence - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Double​Endorsement​Evidence -

- -
-
public class OperationDoubleEndorsementEvidence: Operation  
-
-
-

Operation to report a baker trying to endorse a block twice

- -
-
- -
- - - - - - -%97 - - - -OperationDoubleEndorsementEvidence - - -OperationDoubleEndorsementEvidence - - - - - -Operation - - -Operation - - - - - -OperationDoubleEndorsementEvidence->Operation - - - - - - - - -
-

Nested Types

-
-
OperationDoubleEndorsementEvidence.InlinedEndorsement
-

Internal struct used to amtch expected struct of data

-
-
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(wallet:​op1:​op2:​) -

-
-
public init(wallet: Wallet, op1: InlinedEndorsement, op2: InlinedEndorsement)  
-
-
-

Init with wallet and 2 suspected endorsements

- -
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- op1 -

-
-
public let op1: InlinedEndorsement
-
-
-

The first endorsement

- -
-
-
-

- op2 -

-
-
public let op2: InlinedEndorsement
-
-
-

The second endorsement (should be matching details of first)

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationDoubleEndorsementEvidence) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/OperationDoubleEndorsementEvidence_InlinedEndorsement/index.html b/OperationDoubleEndorsementEvidence_InlinedEndorsement/index.html deleted file mode 100644 index e13203f0..00000000 --- a/OperationDoubleEndorsementEvidence_InlinedEndorsement/index.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - KukaiCoreSwift - OperationDoubleEndorsementEvidence.InlinedEndorsement - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Double​Endorsement​Evidence.​Inlined​Endorsement -

- -
-
public struct InlinedEndorsement: Codable, Equatable  
-
-
-

Internal struct used to amtch expected struct of data

- -
-
- -
- - - - - - -%553 - - - -OperationDoubleEndorsementEvidence.InlinedEndorsement - - -OperationDoubleEndorsementEvidence.InlinedEndorsement - - - - - -Equatable - -Equatable - - - -OperationDoubleEndorsementEvidence.InlinedEndorsement->Equatable - - - - - -Codable - -Codable - - - -OperationDoubleEndorsementEvidence.InlinedEndorsement->Codable - - - - - - - - -
-

Member Of

-
-
OperationDoubleEndorsementEvidence
-

Operation to report a baker trying to endorse a block twice

-
-
-

Nested Types

-
-
OperationDoubleEndorsementEvidence.InlinedEndorsement.Content
-
-
-

Conforms To

-
-
Codable
-
Equatable
-
-
-
-

Properties

- -
-

- branch -

-
-
public let branch: String
-
-
-
-

- operations -

-
-
public let operations: Content
-
-
-
-

- signature -

-
-
public let signature: String? 
-
-
-
- - - -
-
- - - - diff --git a/OperationDoubleEndorsementEvidence_InlinedEndorsement_Content/index.html b/OperationDoubleEndorsementEvidence_InlinedEndorsement_Content/index.html deleted file mode 100644 index 30dcfd4b..00000000 --- a/OperationDoubleEndorsementEvidence_InlinedEndorsement_Content/index.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - KukaiCoreSwift - OperationDoubleEndorsementEvidence.InlinedEndorsement.Content - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Double​Endorsement​Evidence.​Inlined​Endorsement.​Content -

- -
-
public struct Content: Codable, Equatable  
-
-
- -
- - - - - - -%805 - - - -OperationDoubleEndorsementEvidence.InlinedEndorsement.Content - - -OperationDoubleEndorsementEvidence.InlinedEndorsement.Content - - - - - -Equatable - -Equatable - - - -OperationDoubleEndorsementEvidence.InlinedEndorsement.Content->Equatable - - - - - -Codable - -Codable - - - -OperationDoubleEndorsementEvidence.InlinedEndorsement.Content->Codable - - - - - - - - -
-

Member Of

-
-
OperationDoubleEndorsementEvidence.InlinedEndorsement
-

Internal struct used to amtch expected struct of data

-
-
-

Conforms To

-
-
Codable
-
Equatable
-
-
-
-

Properties

- -
-

- kind -

-
-
public let kind: OperationKind
-
-
-
-

- level -

-
-
public let level: Int
-
-
-
- - - -
-
- - - - diff --git a/OperationEndorsement/index.html b/OperationEndorsement/index.html deleted file mode 100644 index df5f759c..00000000 --- a/OperationEndorsement/index.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - KukaiCoreSwift - OperationEndorsement - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Endorsement -

- -
-
public class OperationEndorsement: Operation  
-
-
-

Operation for endorsing a block

- -
-
- -
- - - - - - -%335 - - - -OperationEndorsement - - -OperationEndorsement - - - - - -Operation - - -Operation - - - - - -OperationEndorsement->Operation - - - - - - - - -
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(wallet:​level:​) -

-
-
public init(wallet: Wallet, level: Int)  
-
-
-

Init with wallet and block level

- -
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- level -

-
-
public let level: Int
-
-
-

Block level

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationEndorsement) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/OperationFactory/index.html b/OperationFactory/index.html deleted file mode 100644 index 981d73f2..00000000 --- a/OperationFactory/index.html +++ /dev/null @@ -1,797 +0,0 @@ - - - - - - KukaiCoreSwift - OperationFactory - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Factory -

- -
-
public class OperationFactory  
-
-
-

Class responsible for creating operations necessary to perform a given action, and converting those operations into the single payload expected by the RPC. -Although not every action requires more than one operation, all functions will return an array, for consistency.

- -
-
- - -

Nested Types

-
-
OperationFactory.Extractor
-

Internal Struct to encapsulate helpers methods needed to extract critical information from an array of operations, needed for processing decisions like "do i display a send token screen, or a send NFt screen", fetching total XTZ sent in 1 action etc

-
-
-
-
-

Methods

- -
-

- send​Operation(_:​of:​from:​to:​) -

-
-
public static func sendOperation(_ tokenAmount: TokenAmount, of token: Token, from: String, to: String) -> [Operation]  
-
-
-

Create the operations necessary to send an amount of a token to a destination address.

- -
-
-
    -
  • -

    parameter _: The amount of the given token to send.

    -
  • -
- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
ofToken

The Token type that will be sent.

-
fromString

The address to deduct the funds from.

-
toString

The destination address that will recieve the funds.

-
-

Returns

-

An array of Operation subclasses.

- -
-
-

- send​Operation(_:​of​Nft:​from:​to:​) -

-
-
public static func sendOperation(_ amount: Decimal, ofNft nft: NFT, from: String, to: String) -> [Operation]  
-
-
-

Create the operations necessary to send aan NFT

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
parameter

The amount of the given token to send.

-
of​NftNFT

The NFT type that will be sent.

-
fromString

The address to deduct the funds from.

-
toString

The destination address that will recieve the funds.

-
-

Returns

-

An array of Operation subclasses.

- -
-
-

- delegate​Operation(to:​from:​) -

-
-
public static func delegateOperation(to: String, from: String) -> [Operation]  
-
-
-

Create the operations necessary to delegate funds to a baker.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
toString

The address of the baker to delegate to.

-
fromString

The address that wishes to delegate its funds.

-
-

Returns

-

An array of Operation subclasses.

- -
-
-

- undelegate​Operation(address:​) -

-
-
public static func undelegateOperation(address: String) -> [Operation]  
-
-
-

Create the operations necessary to remove the current delegate from an address.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
addressString

The address that wishes to remove its delegate.

-
-

Returns

-

An array of Operation subclasses.

- -
-
-

- swap​Xtz​ToToken(with​Dex:​xtz​Amount:​min​Token​Amount:​wallet​Address:​timeout:​) -

-
-
public static func swapXtzToToken(withDex dex: DipDupExchange, xtzAmount: XTZAmount, minTokenAmount: TokenAmount, walletAddress: String, timeout: TimeInterval) -> [Operation]  
-
-
-

Create the operations necessary to perform an exchange of XTZ for a given FA token, using a given dex

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
with​DexDip​Dup​Exchange

Enum controling which dex to use to perform the swap

-
xtz​AmountXTZAmount

The amount of XTZ to be swaped

-
min​Token​AmountToken​Amount

The minimum token amount you will accept

-
wallet

The wallet signing the operation

-
timeoutTime​Interval

Max amount of time to wait before asking the node to cancel the operation

-
-

Returns

-

An array of Operation subclasses.

- -
-
-

- swap​Token​ToXTZ(with​Dex:​token​Amount:​min​XTZAmount:​wallet​Address:​timeout:​) -

-
-
public static func swapTokenToXTZ(withDex dex: DipDupExchange, tokenAmount: TokenAmount, minXTZAmount: XTZAmount, walletAddress: String, timeout: TimeInterval) -> [Operation]  
-
-
-

Create the operations necessary to perform an exchange of a given FA token for XTZ, using dex contracts

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
with​DexDip​Dup​Exchange

DipDupExchange instance providing information about the exchange

-
token​AmountToken​Amount

The amount of Token to be swapped

-
min​XTZAmountXTZAmount

The minimum xtz amount you will accept

-
wallet

The wallet signing the operation

-
timeoutTime​Interval

Max amount of time to wait before asking the node to cancel the operation

-
-

Returns

-

An array of Operation subclasses.

- -
-
-

- approve​Operation(token​Address:​spender​Address:​allowance:​wallet​Address:​) -

-
-
public static func approveOperation(tokenAddress: String, spenderAddress: String, allowance: TokenAmount, walletAddress: String) -> Operation  
-
-
-

Create an operation to call the entrypoint approve, to allow another address to spend some of your token (only FA1.2) -Used when interacting with smart contract applications like Dexter or QuipuSwap

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
token​AddressString

The address of the token contract

-
spender​AddressString

The address that is being given permission to spend the users balance

-
allowanceToken​Amount

The allowance to set for the given contract

-
wallet

The wallet signing the operation

-
-

Returns

-

An OperationTransaction which will invoke a smart contract call

- -
-
-

- update​Operators​Operation(token​Address:​spender​Address:​allowance:​wallet​Address:​) -

-
-
public static func updateOperatorsOperation(tokenAddress: String, spenderAddress: String, allowance: TokenAmount, walletAddress: String) -> Operation  
-
-
-

Create an operation to call the entrypoint update_operators, to allow another address to spend some of your token (only FA2) -Used when interacting with smart contract applications like Dexter or QuipuSwap

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
token​AddressString

The address of the token contract

-
spender​AddressString

The address that is being given permission to spend the users balance

-
allowanceToken​Amount

The allowance to set for the given contract

-
wallet

The wallet signing the operation

-
-

Returns

-

An OperationTransaction which will invoke a smart contract call

- -
-
-

- allowance​Operation(standard:​token​Address:​spender​Address:​allowance:​wallet​Address:​) -

-
-
public static func allowanceOperation(standard: DipDupTokenStandard, tokenAddress: String, spenderAddress: String, allowance: TokenAmount, walletAddress: String) -> Operation  
-
-
-

Return the operation necessary to register an allowance (either calling apporve or update_operators) depending on the token standard version. Removing the need to check manually -Used when interacting with smart contract applications like Dexter or QuipuSwap

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
standardDip​Dup​Token​Standard

The FA standard that the token conforms too

-
token​AddressString

The address of the token contract

-
spender​AddressString

The address that is being given permission to spend the users balance

-
allowanceToken​Amount

The allowance to set for the given contract

-
wallet

The wallet signing the operation

-
-

Returns

-

An OperationTransaction which will invoke a smart contract call

- -
-
-

- add​Liquidity(with​Dex:​xtz:​token:​min​Liquidty:​is​Initial​Liquidity:​wallet​Address:​timeout:​) -

-
-
public static func addLiquidity(withDex dex: DipDupExchange, xtz: XTZAmount, token: TokenAmount, minLiquidty: TokenAmount, isInitialLiquidity: Bool, walletAddress: String, timeout: TimeInterval) -> [Operation]  
-
-
-

Create the operations necessary to add liquidity to a dex contract. Use DexCalculationService to figure out the numbers required

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
with​DexDip​Dup​Exchange

DipDupExchange instance providing information about the exchange

-
xtzXTZAmount

The amount of XTZ to deposit

-
tokenToken​Amount

The amount of Token to deposit

-
min​LiquidtyToken​Amount

The minimum amount of liquidity tokens you will accept

-
is​Initial​LiquidityBool

Is this the xtzPool and tokenPool empty? If so, the operation needs to set the exchange rate for the dex. Some dex's require extra logic here

-
wallet

The wallet that will sign the operation

-
timeoutTime​Interval

The timeout in seconds, before the dex contract should cancel the operation

-
-

Returns

-

An array of Operation subclasses.

- -
-
-

- remove​Liquidity(with​Dex:​min​XTZ:​min​Token:​liquidity​ToBurn:​wallet​Address:​timeout:​) -

-
-
public static func removeLiquidity(withDex dex: DipDupExchange, minXTZ: XTZAmount, minToken: TokenAmount, liquidityToBurn: TokenAmount, walletAddress: String, timeout: TimeInterval) -> [Operation]  
-
-
-

Create the operations necessary to remove liquidity from a dex contract, also withdraw pending rewards if applicable. Use DexCalculationService to figure out the numbers required

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
with​DexDip​Dup​Exchange

DipDupExchange instance providing information about the exchange

-
min​XTZXTZAmount

The minimum XTZ to accept in return for the burned amount of Liquidity

-
min​TokenToken​Amount

The minimum Token to accept in return for the burned amount of Liquidity

-
liquidity​ToBurnToken​Amount

The amount of Liqudity to burn

-
wallet

The wallet that will sign the operation

-
timeoutTime​Interval

The timeout in seconds, before the dex contract should cancel the operation

-
-

Returns

-

An array of Operation subclasses.

- -
-
-

- withdraw​Rewards(with​Dex:​wallet​Address:​) -

-
-
public static func withdrawRewards(withDex dex: DipDupExchange, walletAddress: String) -> [Operation]  
-
-
-

Create the operations necessary to withdraw rewards from a dex contract. For example in quipuswap, XTZ provided as liquidity will earn baking rewards. This can been withdrawn at any time while leaving liquidity in palce

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
with​DexDip​Dup​Exchange

DipDupExchange instance providing information about the exchange

-
wallet

The wallet that will sign the operation

-
-

Returns

-

An array of Operation subclasses.

- -
-
-

- operation​Payload(from​Metadata:​and​Operations:​wallet​Address:​base58Encoded​Public​Key:​) -

-
-
public static func operationPayload(fromMetadata metadata: OperationMetadata, andOperations operations: [Operation], walletAddress: String, base58EncodedPublicKey: String) -> OperationPayload  
-
-
-

Convert an array of operations into the format expected by the RPC. Will also inject a OperationReveal if the sender has not yet revealed their public key.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
from​MetadataOperation​Metadata

OperationMeatdata containing necessary data to form the object.

-
and​Operations[Operation]

An array of Operation subclasses to send.

-
with​Wallet

The Wallet instance that will be responsible for these operations.

-
-

Returns

-

An instance of OperationPayload that can be sent to the RPC

- -
-
-

- create​Dexter​Timestamp​String(now​Plus​Time​Interval:​) -

-
-
public static func createDexterTimestampString(nowPlusTimeInterval: TimeInterval) -> String  
-
-
-

Dexter requires date strings to act as deadline dates for exchanges. -This function takes a TimeInterval and uses it to createa date in the future, and returns that as a formatted string.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
now​Plus​Time​IntervalTime​Interval

The amount of time in the future the date string should represent.

-
-

Returns

-

A formatted date String

- -
-
-

- send​Token​Michelson(for​FaVersion:​token​Amount:​token​Id:​to:​from:​) -

-
-
public static func sendTokenMichelson(forFaVersion faVersion: FaVersion, tokenAmount: TokenAmount, tokenId: Decimal, to: String, from: String) -> [String: Any]  
-
-
-
- - - -
-
- - - - diff --git a/OperationFactory_Extractor/index.html b/OperationFactory_Extractor/index.html deleted file mode 100644 index dab60ccc..00000000 --- a/OperationFactory_Extractor/index.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - KukaiCoreSwift - OperationFactory.Extractor - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Factory.​Extractor -

- -
-
public struct Extractor  
-
-
-

Internal Struct to encapsulate helpers methods needed to extract critical information from an array of operations, needed for processing decisions like "do i display a send token screen, or a send NFt screen", fetching total XTZ sent in 1 action etc

- -
-
- - -

Member Of

-
-
OperationFactory
-

Class responsible for creating operations necessary to perform a given action, and converting those operations into the single payload expected by the RPC. -Although not every action requires more than one operation, all functions will return an array, for consistency.

-
-
-
-
-

Methods

- -
-

- token​IdAnd​Amount​From​Send​Michelson(michelson:​) -

-
-
public static func tokenIdAndAmountFromSendMichelson(michelson: Any) -> (rpcAmount: String, tokenId: Decimal?, destination: String)?  
-
-
-

Extract rpc amount (without decimal info) a tokenId, and the destination from a michelson FA1.2 / FA2 transfer payload

- -
-
-
-

- fa​Token​Details​From(transaction:​) -

-
-
public static func faTokenDetailsFrom(transaction: OperationTransaction) -> (tokenContract: String, rpcAmount: String, tokenId: Decimal?, destination: String)?  
-
-
-

Extract details from a payload in order to present to the user what it is they are trying to send

- -
-
-
-

- fa​Token​Details​From(operations:​) -

-
-
public static func faTokenDetailsFrom(operations: [Operation]) -> (tokenContract: String, rpcAmount: String, tokenId: Decimal?, destination: String)?  
-
-
-

Helper to call faTokenDetailsFrom(transaction: OperationTransaction) on the first OperationTransaction in an array of operations. Allows to more easily parse an array of operations that may include approval's or update_operator calls

- -
-
-
-

- is​Tez​Transfer(operations:​) -

-
-
public static func isTezTransfer(operations: [Operation]) -> Bool  
-
-
-

Return true if

- -
-
-
    -
  • -

    contains 1 operation with a non-zero amount, with no parameters

    -
  • -
- -
-
-
-

- first​Transfer​Entrypoint​Operation(operations:​) -

-
-
public static func firstTransferEntrypointOperation(operations: [Operation]) -> OperationTransaction?  
-
-
-

Easy way to extract the first non-approval or update_operator transaction

- -
-
-
-

- is​Contract​Call(operations:​) -

-
-
public static func isContractCall(operations: [Operation]) -> (entrypoint: String, address: String)?  
-
-
-

Return the entrypoint and address of the first operation, that doesn't equal approve, update_operator or transfer

- -
-
-
-

- first​Contract​Call​Operation(operations:​) -

-
-
public static func firstContractCallOperation(operations: [Operation]) -> OperationTransaction?  
-
-
-

Return the first operation where entrypoint doesn't equal approve, update_operator or transfer

- -
-
-
-

- total​XTZAmount​For​Contract​Call(operations:​) -

-
-
public static func totalXTZAmountForContractCall(operations: [Operation]) -> XTZAmount  
-
-
-

Run through list of operations and extract .amount from any OperationTransaction

- -
-
-
- - - -
-
- - - - diff --git a/OperationFees/index.html b/OperationFees/index.html deleted file mode 100644 index f63ff12f..00000000 --- a/OperationFees/index.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - KukaiCoreSwift - OperationFees - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Fees -

- -
-
public struct OperationFees: Equatable  
-
-
-

A structure representing all the fees, storage and computation needed to perform an Operation

- -
-
- -
- - - - - - -%419 - - - -OperationFees - - -OperationFees - - - - - -Equatable - -Equatable - - - -OperationFees->Equatable - - - - - - - - -
-

Nested Types

-
-
OperationFees.NetworkFeeType
-

Enum to differentiate different types of extra fees. Such as allocation fees when sending to a currently unrevealed account.

-
-
-

Conforms To

-
-
Equatable
-
-
-
-

Properties

- -
-

- transaction​Fee -

-
-
public var transactionFee: XTZAmount
-
-
-

The transaction fee that the sender is willing to pay in order to perform the Operation. -Strictly speaking operations don't have a fee, but a gas cost, and fees and offered by the user instead. -Practically, bakers will prioritsie Operation's with higher fees. Resulting in default feePerGas rate being required in order to get a transaction through.

- -
-
-
-

- network​Fees -

-
-
public var networkFees: [NetworkFeeType: XTZAmount] = [:] 
-
-
-

Additional fees the account will have to pay in order to send this operation. Such as allocating space for an unrevealed account.

- -
-
-
-

- gas​Limit -

-
-
public var gasLimit: Int
-
-
-

The limit of gas (computation + CPU) this Operation should take. If it exceeds this value when running, the Operation will fail.

- -
-
-
-

- storage​Limit -

-
-
public var storageLimit: Int
-
-
-

The limit of storage (disk) this Operation requires to complete. If it exceeds this value when running, the Operation will fail.

- -
-
-
-
-

Methods

- -
-

- all​Fees() -

-
-
public func allFees() -> XTZAmount  
-
-
-

Add together all the network fees and transaction fees

- -
-
-
-

- all​Network​Fees() -

-
-
public func allNetworkFees() -> XTZAmount  
-
-
-

Add together all the network fees and transaction fees

- -
-
-
-

- zero() -

-
-
public static func zero() -> OperationFees  
-
-
-

Creates an OperationFees object, with everything set to zero. Primarly used as a default / placeholder until an estimation can be performed

- -
-
-
-

- default​Fees(operation​Kind:​) -

-
-
public static func defaultFees(operationKind: OperationKind) -> OperationFees  
-
-
-

Get a default fees for each type of Operation. No guarentee these will succeed.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
operation​KindOperation​Kind

enum to denote the type of Operation

-
-

Returns

-

a OperationFees object with all the values set.

- -
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: OperationFees, rhs: OperationFees) -> Bool  
-
-
-

Confirming to Equatable

- -
-
-
- - - -
-
- - - - diff --git a/OperationFees_NetworkFeeType/index.html b/OperationFees_NetworkFeeType/index.html deleted file mode 100644 index 6fb9a42a..00000000 --- a/OperationFees_NetworkFeeType/index.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - KukaiCoreSwift - OperationFees.NetworkFeeType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Operation​Fees.​Network​Fee​Type -

- -
-
public enum NetworkFeeType: String  
-
-
-

Enum to differentiate different types of extra fees. Such as allocation fees when sending to a currently unrevealed account.

- -
-
- -
- - - - - - -%331 - - - -OperationFees.NetworkFeeType - - -OperationFees.NetworkFeeType - - - - - -String - -String - - - -OperationFees.NetworkFeeType->String - - - - - - - - -
-

Member Of

-
-
OperationFees
-

A structure representing all the fees, storage and computation needed to perform an Operation

-
-
-

Conforms To

-
-
String
-
-
-
-

Enumeration Cases

- -
-

- burn​Fee -

-
-
case burnFee
-
-
-
-

- allocation​Fee -

-
-
case allocationFee
-
-
-
- - - -
-
- - - - diff --git a/OperationKind/index.html b/OperationKind/index.html deleted file mode 100644 index 5220cef0..00000000 --- a/OperationKind/index.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - - - KukaiCoreSwift - OperationKind - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Operation​Kind -

- -
-
public enum OperationKind: String, Codable  
-
-
-

Enum representing the various kinds of supported Operation's

- -
-
- -
- - - - - - -%85 - - - -OperationKind - - -OperationKind - - - - - -String - -String - - - -OperationKind->String - - - - - -Codable - -Codable - - - -OperationKind->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Initializers

- -
-

- init(from:​) -

-
-
public init(from decoder: Decoder) throws  
-
-
-

Create a base operation.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
fromDecoder

A decoder used to convert a data fromat (such as JSON) into the model object.

-
-
-
-
-

Enumeration Cases

- -
-

- transaction -

-
-
case transaction
-
-
-
-

- reveal -

-
-
case reveal
-
-
-
-

- delegation -

-
-
case delegation
-
-
-
-

- origination -

-
-
case origination
-
-
-
-

- activate_account -

-
-
case activate_account
-
-
-
-

- endorsement -

-
-
case endorsement
-
-
-
-

- seed_nonce_revelation -

-
-
case seed_nonce_revelation
-
-
-
-

- double_endorsement_evidence -

-
-
case double_endorsement_evidence
-
-
-
-

- double_baking_evidence -

-
-
case double_baking_evidence
-
-
-
-

- proposals -

-
-
case proposals
-
-
-
-

- ballot -

-
-
case ballot
-
-
-
-

- unknown -

-
-
case unknown
-
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public func encode(to encoder: Encoder) throws  
-
-
-

Convert the object into a data format, such as JSON.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
toEncoder

An encoder that will allow conversions to multipel data formats.

-
-
-
- - - -
-
- - - - diff --git a/OperationMetadata/index.html b/OperationMetadata/index.html deleted file mode 100644 index 6e93a13b..00000000 --- a/OperationMetadata/index.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - - KukaiCoreSwift - OperationMetadata - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Metadata -

- -
-
public struct OperationMetadata: Codable  
-
-
-

Structure representing the metadata needed by Operation's in order to comply with the RPC standards

- -
-
- -
- - - - - - -%675 - - - -OperationMetadata - - -OperationMetadata - - - - - -Codable - -Codable - - - -OperationMetadata->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(manager​Key:​counter:​blockchain​Head:​) -

-
-
public init(managerKey: String?, counter: Int, blockchainHead: BlockchainHead)  
-
-
-

Create an OperationMetadata

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
manager​KeyString?

The public key of the account managing the sender of this Operation

-
counterInt

The current counter used by this account on the network. All future Operation's need to be 1 higher

-
blockchain​HeadBlockchain​Head

Decoded response of the blockchainHead, containing only the pieces we need

-
-
-
-
-

Properties

- -
-

- manager​Key -

-
-
public let managerKey: String? 
-
-
-

The public key of the account managing the sender of this Operation

- -
-
-
-

- counter -

-
-
public let counter: Int
-
-
-

The current counter used by this account on the network. All future Operation's need to be 1 higher

- -
-
-
-

- chain​ID -

-
-
public let chainID: String
-
-
-

The current Tezos network chainID to use for Operation's

- -
-
-
-

- branch -

-
-
public let branch: String
-
-
-

The current branch used by the head block, used for estiamting and running preapply, to ensure the latest state information is available

- -
-
-
-

- `protocol` -

-
-
public let `protocol`: String
-
-
-

The current Tezos network protocol to use for Operation's

- -
-
-
- - - -
-
- - - - diff --git a/OperationOrigination/index.html b/OperationOrigination/index.html deleted file mode 100644 index 9adbebfa..00000000 --- a/OperationOrigination/index.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - KukaiCoreSwift - OperationOrigination - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Origination -

- -
-
public class OperationOrigination: Operation  
-
-
-

Operation subclass for originating a contract on the Tezos network

- -
-
- -
- - - - - - -%549 - - - -OperationOrigination - - -OperationOrigination - - - - - -Operation - - -Operation - - - - - -OperationOrigination->Operation - - - - - - - - -
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(source:​balance:​code:​storage:​) -

-
-
public init(source: String, balance: XTZAmount, code: String, storage: String)  
-
-
-

Create an OperationOrigination.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
sourceString

The address originating the contract and paying the fees.

-
balanceXTZAmount

How much XTZ to initiate the contract with.

-
codeString

Micheline string containing the contract code.

-
storageString

Micheline string containing the initial storage of the contract.

-
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-

Create a base operation.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
fromDecoder

A decoder used to convert a data fromat (such as JSON) into the model object.

-
-
-
-
-

Properties

- -
-

- balance -

-
-
public let balance: String
-
-
-

The initial balance to give to the contract

- -
-
-
-

- script -

-
-
public let script: [String: String] 
-
-
-

Dictionary holding the code and storage of the contract to create.

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-

Convert the object into a data format, such as JSON.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
toEncoder

An encoder that will allow conversions to multipel data formats.

-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationOrigination) -> Bool  
-
-
-

A function to check if two operations are equal.

- -
-
-
    -
  • -

    parameter _: An Operation to compare against

    -
  • -
- -
-

Returns

-

A Bool indicating the result.

- -
-
- - - -
-
- - - - diff --git a/OperationPayload/index.html b/OperationPayload/index.html deleted file mode 100644 index 8a6c5d42..00000000 --- a/OperationPayload/index.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - KukaiCoreSwift - OperationPayload - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Payload -

- -
-
public struct OperationPayload: Codable, Equatable  
-
-
-

A structure representing the request that needs to be made when sending Opertion's to the RPC

- -
-
- -
- - - - - - -%283 - - - -OperationPayload - - -OperationPayload - - - - - -Equatable - -Equatable - - - -OperationPayload->Equatable - - - - - -Codable - -Codable - - - -OperationPayload->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Equatable
-
-
-
-

Properties

- -
-

- branch -

-
-
public var branch: String
-
-
-

The bracnh to use when sending

- -
-
-
-

- contents -

-
-
public var contents: [Operation] 
-
-
-

An array of Operation's to be sent together in 1 request.

- -
-
-
-
-

Methods

- -
-

- add​Signature(_:​signing​Curve:​) -

-
-
public mutating func addSignature(_ binarySignature: [UInt8], signingCurve: EllipticalCurve)  
-
-
-

Add the signature and the protocol to the operation so that it can be injected to the blockchain

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
binary​Signature[UInt8]

Use the Wallet.sign(...) function to sign the forged version of the operationPayload.

-
signing​CurveElliptical​Curve

The EllipticalCurve used for signing.

-
and​Protocol

An OperationMetadata containing the network protocol to use to perform the injection.

-
-
-
-

- add​Protcol(from​Metadata:​) -

-
-
public mutating func addProtcol(fromMetadata metadata: OperationMetadata)  
-
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: OperationPayload, rhs: OperationPayload) -> Bool  
-
-
-

Conforming to Equatable

- -
-
-
- - - -
-
- - - - diff --git a/OperationProposals/index.html b/OperationProposals/index.html deleted file mode 100644 index 7e12b8c3..00000000 --- a/OperationProposals/index.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - KukaiCoreSwift - OperationProposals - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Proposals -

- -
-
public class OperationProposals: Operation  
-
-
- -
- - - - - - -%71 - - - -OperationProposals - - -OperationProposals - - - - - -Operation - - -Operation - - - - - -OperationProposals->Operation - - - - - - - - -
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(wallet:​period:​proposals:​) -

-
-
public init(wallet: Wallet, period: Int, proposals: [String])  
-
-
-

Init with wallet, voting period and list of proposal identifiers

- -
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- period -

-
-
public let period: Int
-
-
-

The voting period

- -
-
-
-

- proposals -

-
-
public let proposals: [String] 
-
-
-

List of proposal identifiers

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationProposals) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/OperationResponse/index.html b/OperationResponse/index.html deleted file mode 100644 index 2926a68e..00000000 --- a/OperationResponse/index.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - KukaiCoreSwift - OperationResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Response -

- -
-
public struct OperationResponse: Codable  
-
-
-

Structure representing the response returned from RPC endpoints such as .../preapply/operations

- -
-
- -
- - - - - - -%151 - - - -OperationResponse - - -OperationResponse - - - - - -Codable - -Codable - - - -OperationResponse->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- contents -

-
-
public let contents: [OperationResponseContent] 
-
-
-
-
-

Methods

- -
-

- is​Failed() -

-
-
public func isFailed() -> Bool  
-
-
-

Check if the operation(s) have been backtracked or reversed due to a failure

- -
-
-
-

- errors() -

-
-
public func errors() -> [OperationResponseInternalResultError]  
-
-
-

Return the last error object from each internal result. The last error object is the one that contains the location of the error in the smart contract and the with string, giving the most debugable information

- -
-
-
- - - -
-
- - - - diff --git a/OperationResponseContent/index.html b/OperationResponseContent/index.html deleted file mode 100644 index 21f72e6f..00000000 --- a/OperationResponseContent/index.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - KukaiCoreSwift - OperationResponseContent - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Response​Content -

- -
-
public struct OperationResponseContent: Codable  
-
-
-

The main content of the JSON returned

- -
-
- -
- - - - - - -%225 - - - -OperationResponseContent - - -OperationResponseContent - - - - - -Codable - -Codable - - - -OperationResponseContent->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
- - - - -
-
- - - - diff --git a/OperationResponseInternalOperation/index.html b/OperationResponseInternalOperation/index.html deleted file mode 100644 index e40324df..00000000 --- a/OperationResponseInternalOperation/index.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - KukaiCoreSwift - OperationResponseInternalOperation - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Response​Internal​Operation -

- -
-
public struct OperationResponseInternalOperation: Codable  
-
-
-

Definition of the internal operation found inside OperationResponse

- -
-
- -
- - - - - - -%415 - - - -OperationResponseInternalOperation - - -OperationResponseInternalOperation - - - - - -Codable - -Codable - - - -OperationResponseInternalOperation->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
- - - - -
-
- - - - diff --git a/OperationResponseInternalResultError/index.html b/OperationResponseInternalResultError/index.html deleted file mode 100644 index cc99bad9..00000000 --- a/OperationResponseInternalResultError/index.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - KukaiCoreSwift - OperationResponseInternalResultError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Response​Internal​Result​Error -

- -
-
public struct OperationResponseInternalResultError: Codable, Equatable  
-
-
-

Definition of the outer Error object found inside OperationResponseInternalResult

- -
-
- -
- - - - - - -%759 - - - -OperationResponseInternalResultError - - -OperationResponseInternalResultError - - - - - -Codable - -Codable - - - -OperationResponseInternalResultError->Codable - - - - - -Equatable - -Equatable - - - -OperationResponseInternalResultError->Equatable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Equatable
-
-
-
-

Properties

- -
-

- kind -

-
-
public let kind: String
-
-
-
-

- id -

-
-
public let id: String
-
-
-
-

- contract -

-
-
public let contract: String? 
-
-
-
-

- expected -

-
-
public let expected: String? 
-
-
-
-

- found -

-
-
public let found: String? 
-
-
-
-

- location -

-
-
public let location: Int? 
-
-
-
-

- with -

-
-
public let with: FailWith? 
-
-
-
- - - -
-
- - - - diff --git a/OperationResponseMetadata/index.html b/OperationResponseMetadata/index.html deleted file mode 100644 index 89c2cd78..00000000 --- a/OperationResponseMetadata/index.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - KukaiCoreSwift - OperationResponseMetadata - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Response​Metadata -

- -
-
public struct OperationResponseMetadata: Codable  
-
-
-

The metadata belonging to the OperationResponse

- -
-
- -
- - - - - - -%229 - - - -OperationResponseMetadata - - -OperationResponseMetadata - - - - - -Codable - -Codable - - - -OperationResponseMetadata->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
- - - - -
-
- - - - diff --git a/OperationResponseResult/index.html b/OperationResponseResult/index.html deleted file mode 100644 index a70b5985..00000000 --- a/OperationResponseResult/index.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - KukaiCoreSwift - OperationResponseResult - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Response​Result -

- -
-
public struct OperationResponseResult: Codable  
-
-
-

The inner result key from the OeprationResponse

- -
-
- -
- - - - - - -%575 - - - -OperationResponseResult - - -OperationResponseResult - - - - - -Codable - -Codable - - - -OperationResponseResult->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
- - - - -
-
- - - - diff --git a/OperationReveal/index.html b/OperationReveal/index.html deleted file mode 100644 index 6c6f334e..00000000 --- a/OperationReveal/index.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - - KukaiCoreSwift - OperationReveal - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Reveal -

- -
-
public class OperationReveal: Operation  
-
-
-

Operation subclass for revealing a publickey to the network.

- -
-
- -
- - - - - - -%679 - - - -OperationReveal - - -OperationReveal - - - - - -Operation - - -Operation - - - - - -OperationReveal->Operation - - - - - - - - -
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(wallet:​) -

-
-
public init(wallet: Wallet)  
-
-
-

Create an OperationReveal.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
walletWallet

The Wallet object, whose publicKey needs to be revealed.

-
-
-
-

- init(base58Encoded​Public​Key:​wallet​Address:​) -

-
-
public init(base58EncodedPublicKey: String, walletAddress: String)  
-
-
-

Create an OperationReveal.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
base58Encoded​Public​KeyString

The Wallet object, whose publicKey needs to be revealed.

-
wallet​AddressString

The Wallet object, whose publicKey needs to be revealed.

-
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-

Create a base operation.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
fromDecoder

A decoder used to convert a data fromat (such as JSON) into the model object.

-
-
-
-
-

Properties

- -
-

- public​Key -

-
-
public let publicKey: String
-
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-

Convert the object into a data format, such as JSON.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
toEncoder

An encoder that will allow conversions to multipel data formats.

-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationReveal) -> Bool  
-
-
-

A function to check if two operations are equal.

- -
-
-
    -
  • -

    parameter _: An Operation to compare against

    -
  • -
- -
-

Returns

-

A Bool indicating the result.

- -
-
- - - -
-
- - - - diff --git a/OperationSeedNonceRevelation/index.html b/OperationSeedNonceRevelation/index.html deleted file mode 100644 index 37d32286..00000000 --- a/OperationSeedNonceRevelation/index.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - KukaiCoreSwift - OperationSeedNonceRevelation - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Seed​Nonce​Revelation -

- -
-
public class OperationSeedNonceRevelation: Operation  
-
-
-

Operation to reveal seed nonce to blockchain

- -
-
- -
- - - - - - -%691 - - - -OperationSeedNonceRevelation - - -OperationSeedNonceRevelation - - - - - -Operation - - -Operation - - - - - -OperationSeedNonceRevelation->Operation - - - - - - - - -
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(wallet:​level:​nonce:​) -

-
-
public init(wallet: Wallet, level: Int, nonce: String)  
-
-
-

Init with wallet object, block level, and nonce

- -
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- level -

-
-
public let level: Int
-
-
-

Block level

- -
-
-
-

- nonce -

-
-
public let nonce: String
-
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationSeedNonceRevelation) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/OperationService/index.html b/OperationService/index.html deleted file mode 100644 index cf8f75f3..00000000 --- a/OperationService/index.html +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - KukaiCoreSwift - OperationService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Service -

- -
-
public class OperationService  
-
-
-

Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

- -
-
- - -

Nested Types

-
-
OperationService.OperationServiceError
-

Errors that the OperationService is capable of returning

-
-
OperationService.LedgerPayloadPrepResponse
-

Used to return a bunch of formatted data, to make interacting with ledger sign operation easier

-
-
-
-
-

Initializers

- -
-

- init(config:​network​Service:​) -

-
-
public init(config: TezosNodeClientConfig = TezosNodeClientConfig(withDefaultsForNetworkType: .mainnet), networkService: NetworkService)  
-
-
-

Init a TezosNodeClient with a TezosNodeClientConfig.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
configTezos​Node​Client​Config

A configuration object containing all the necessary settings to connect and communicate with the Tezos node.

-
-
-
-
-

Properties

- -
-

- config -

-
-
public let config: TezosNodeClientConfig
-
-
-

The configuration object containing all the necessary settings to connect and communicate with the Tezos node

- -
-
-
-

- network​Service -

-
-
public let networkService: NetworkService
-
-
-

The NetworkService object that will perform all the networking calls

- -
-
-
-
-

Methods

- -
-

- remote​Forge​Parse​Sign​Preapply​Inject(operation​Metadata:​operation​Payload:​wallet:​completion:​) -

-
-
public func remoteForgeParseSignPreapplyInject(operationMetadata: OperationMetadata, operationPayload: OperationPayload, wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

When using remote forging, every Operation needs to be Forged, Parsed, Signed, Preapply'd and Injected to make its way into the blockchain. -This function will complete all of those steps and return an OperationID or an Error.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
operation​MetadataOperation​Metadata

The latest OperationMetadata from the TezosNodeClient

-
operation​PayloadOperation​Payload

The OperationPayload generated by the OperationFactory

-
walletWallet

The Wallet that will sign the operation

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

Completion block either returning a String containing an OperationHash of the injected Operation, or an Error

-
-
-
-

- local​Forge​Sign​Preapply​Inject(operation​Metadata:​operation​Payload:​wallet:​completion:​) -

-
-
public func localForgeSignPreapplyInject(operationMetadata: OperationMetadata, operationPayload: OperationPayload, wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

When using local forging, every Operation needs to be Forged, Signed, Preapply'd and Injected to make its way into the blockchain. -This function will complete all of those steps and return an OperationID or an Error.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
operation​MetadataOperation​Metadata

The latest OperationMetadata from the TezosNodeClient

-
operation​PayloadOperation​Payload

The OperationPayload generated by the OperationFactory

-
walletWallet

The Wallet that will sign the operation

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

Completion block either returning a String containing an OperationHash of the injected Operation, or an Error

-
-
-
-

- ledger​String​ToSign(forged​Hash:​operation​Payload:​) -

-
-
public func ledgerStringToSign(forgedHash: String, operationPayload: OperationPayload) -> String  
-
-
-

Ledger can only parse operations under certain conditions. These conditions are not documented well. This function will attempt to determine whether the payload can be parsed or not, and returnt he appropriate string for the LedgerWallet sign function -It seems to be able to parse the payload if it contains 1 operation, of the below types. Combining types (like Reveal + Transation) causes a parse error -If the payload structure passes the conditions we are aware of, allow parsing to take place. If not, sign blake2b hash instead

- -
-
-
-

- preapply​And​Inject(forged​Operation:​signature:​signature​Curve:​operation​Payload:​operation​Metadata:​completion:​) -

-
-
public func preapplyAndInject(forgedOperation: String, signature: [UInt8], signatureCurve: EllipticalCurve, operationPayload: OperationPayload, operationMetadata: OperationMetadata, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

Preapply and Inject wrapped up as one function, for situations like Ledger Wallets, where signing is a complately different process, and must be done elsewhere

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
forged​OperationString

The forged operation hex without a watermark.

-
signature[UInt8]

Binary representation of the signed operation forge.

-
signature​CurveElliptical​Curve

The curve used to sign the forge.

-
operation​PayloadOperation​Payload

The payload to be sent.

-
operation​MetadataOperation​Metadata

The metadata required to send the payload.

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

callback with a forged hash or an error.

-
-
-
-

- remote​Forge(operation​Payload:​completion:​) -

-
-
public func remoteForge(operationPayload: OperationPayload, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

Forge an OperationPayload remotely, so it can be sent to the RPC.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
operation​PayloadOperation​Payload

created from OperationFactory.operationPayload().

-
wallet

The Wallet object that will sign the operations.

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

callback with a forged hash or an error.

-
-
-
-

- remote​Parse(forge​Result:​operation​Metadata:​operation​Payload:​completion:​) -

-
-
public func remoteParse(forgeResult: Result<String, KukaiError>, operationMetadata: OperationMetadata, operationPayload: OperationPayload, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

Parse a forged OperationPayload on a different server to ensure nobody maliciously tampared with the request.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
forge​ResultResult<String, Kukai​Error>

The Result object from the forge(...) function.

-
operation​MetadataOperation​Metadata

fetched from getOperationMetadata(...).

-
operation​PayloadOperation​Payload

the OperationPayload to compare against to ensure it matches.

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

callback which just returns success or failure with an error.

-
-
-
-

- preapply(operation​Payload:​completion:​) -

-
-
public func preapply(operationPayload: OperationPayload, completion: @escaping ((Result<[OperationResponse], KukaiError>) -> Void))  
-
-
-

Preapply a signed OperationPayload to check for any errors.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
operation​Metadata

Fetched from getOperationMetadata(...).

-
operation​PayloadOperation​Payload

An OperationPayloadthat has had a signature and a protcol added to it.

-
completion@escaping ((Result<[Operation​Response], Kukai​Error>) -> Void)

Callback which just returns success or failure with an error.

-
-
-
-

- inject(signed​Bytes:​handle​Preapply​Result:​completion:​) -

-
-
public func inject(signedBytes: String, handlePreapplyResult: Result<[OperationResponse], KukaiError>?, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

Inject a signed bytes to become part of the next block on the blockchain

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
signed​BytesString

The result of the forge operation (as a string) with the signature (as a hex string) appended on.

-
handle​Preapply​ResultResult<[Operation​Response], Kukai​Error>?

Optionally pass in the result of the preapply function to reduce the indentation required to perform the full set of operations. Any error will be returned via the injection Result object.

-
-
-
- - - -
-
- - - - diff --git a/OperationService_LedgerPayloadPrepResponse/index.html b/OperationService_LedgerPayloadPrepResponse/index.html deleted file mode 100644 index fafdf54e..00000000 --- a/OperationService_LedgerPayloadPrepResponse/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - KukaiCoreSwift - OperationService.LedgerPayloadPrepResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Service.​Ledger​Payload​Prep​Response -

- -
-
public struct LedgerPayloadPrepResponse  
-
-
-

Used to return a bunch of formatted data, to make interacting with ledger sign operation easier

- -
-
- - -

Member Of

-
-
OperationService
-

Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

-
-
-
-
-

Properties

- -
-

- payload -

-
-
public let payload: OperationPayload
-
-
-
-

- forged​Op -

-
-
public let forgedOp: String
-
-
-
-

- watermarked​Op -

-
-
public let watermarkedOp: String
-
-
-
-

- blake2bHash -

-
-
public let blake2bHash: String
-
-
-
-

- metadata -

-
-
public let metadata: OperationMetadata
-
-
-
-

- can​Ledger​Parse -

-
-
public let canLedgerParse: Bool
-
-
-
- - - -
-
- - - - diff --git a/OperationService_OperationServiceError/index.html b/OperationService_OperationServiceError/index.html deleted file mode 100644 index 0008d189..00000000 --- a/OperationService_OperationServiceError/index.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - KukaiCoreSwift - OperationService.OperationServiceError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Operation​Service.​Operation​Service​Error -

- -
-
public enum OperationServiceError: Error  
-
-
-

Errors that the OperationService is capable of returning

- -
-
- -
- - - - - - -%239 - - - -OperationService.OperationServiceError - - -OperationService.OperationServiceError - - - - - -Error - -Error - - - -OperationService.OperationServiceError->Error - - - - - - - - -
-

Member Of

-
-
OperationService
-

Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

-
-
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- unable​ToSetup​Forge -

-
-
case unableToSetupForge
-
-
-
-

- unable​ToSetup​Parse -

-
-
case unableToSetupParse
-
-
-
-

- parse​Failed -

-
-
case parseFailed
-
-
-
-

- signing​Failure -

-
-
case signingFailure
-
-
-
-

- unable​ToSetup​Preapply -

-
-
case unableToSetupPreapply
-
-
-
-

- preapply​Contained​Error -

-
-
case preapplyContainedError(errors: [OperationResponseInternalResultError]?) 
-
-
-
-

- unable​ToSetup​Inject -

-
-
case unableToSetupInject
-
-
-
-

- no​Remote​Parse​URLFound -

-
-
case noRemoteParseURLFound
-
-
-
- - - -
-
- - - - diff --git a/OperationSubscription/index.html b/OperationSubscription/index.html deleted file mode 100644 index 2650ba7a..00000000 --- a/OperationSubscription/index.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - KukaiCoreSwift - OperationSubscription - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Operation​Subscription -

- -
-
public struct OperationSubscription: Codable  
-
-
-

Object for sending a request through SignalR to listen to operations for a given account

- -
-
- -
- - - - - - -%339 - - - -OperationSubscription - - -OperationSubscription - - - - - -Codable - -Codable - - - -OperationSubscription->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
- - - - -
-
- - - - diff --git a/OperationTransaction/index.html b/OperationTransaction/index.html deleted file mode 100644 index dd2ede5b..00000000 --- a/OperationTransaction/index.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - - KukaiCoreSwift - OperationTransaction - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Operation​Transaction -

- -
-
public class OperationTransaction: Operation  
-
-
-

Operation subclass for sending XTZ to a destination

- -
-
- -
- - - - - - -%505 - - - -OperationTransaction - - -OperationTransaction - - - - - -Operation - - -Operation - - - - - -OperationTransaction->Operation - - - - - - - - -
-

Superclass

-
-
Operation
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

-
-
-
-
-

Initializers

- -
-

- init(amount:​source:​destination:​) -

-
-
public init(amount: TokenAmount, source: String, destination: String)  
-
-
-

Create an OperationTransaction, to send an amount of token to a destination

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
amountToken​Amount

The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value.

-
sourceString

The address of the acocunt sending the operation.

-
destinationString

The destination address to recieve the funds.

-
-
-
-

- init(amount:​source:​destination:​parameters:​) -

-
-
public init(amount: TokenAmount, source: String, destination: String, parameters: [String: Any])  
-
-
-

Create an OperationTransaction, to invoke a smart contract call

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
amountToken​Amount

The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value.

-
sourceString

The address of the acocunt sending the operation.

-
parameters[String:​ Any]

A dictionary containing the michlelson JSON representation needed to invoke a smart contract. Should contain a key entrypoint with a string and value which can either be a dictionary of anything, or an array of dicitonaries of anything

-
destinationString

The destination address to recieve the funds.

-
-
-
-

- init(from:​) -

-
-
public required init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- amount -

-
-
public var amount: String
-
-
-

The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value

- -
-
-
-

- destination -

-
-
public let destination: String
-
-
-
-

- parameters -

-
-
public let parameters: [String: Any]? 
-
-
-

Dictionary holding the entrypoint and value of the contract call

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-
-

- is​Equal(_:​) -

-
-
public func isEqual(_ op: OperationTransaction) -> Bool  
-
-
-

A function to check if two operations are equal.

- -
-
-
    -
  • -

    parameter _: An Operation to compare against

    -
  • -
- -
-

Returns

-

A Bool indicating the result.

- -
-
- - - -
-
- - - - diff --git a/OperationTransactionError/index.html b/OperationTransactionError/index.html deleted file mode 100644 index 9ea28245..00000000 --- a/OperationTransactionError/index.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - KukaiCoreSwift - OperationTransactionError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Operation​Transaction​Error -

- -
-
public enum OperationTransactionError: Error  
-
-
- -
- - - - - - -%147 - - - -OperationTransactionError - - -OperationTransactionError - - - - - -Error - -Error - - - -OperationTransactionError->Error - - - - - - - - -
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- invalid​Michelson​Value -

-
-
case invalidMichelsonValue
-
-
-
- - - -
-
- - - - diff --git a/Protocols.html b/Protocols.html new file mode 100644 index 00000000..ed29b185 --- /dev/null +++ b/Protocols.html @@ -0,0 +1,803 @@ + + + + Protocols Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Protocols

+

The following protocols are available globally.

+ +
+
+
+
    +
  • +
    + + + + FailWithParser + +
    +
    +
    +
    +
    +
    +

    Protocol to allow defining multiple dedicated structs, one for each dApp, that knows how to convert the specific failWith cases into more human readable error messages

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public protocol FailWithParser
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Protocols +

+
+
+
    +
  • +
    + + + + Wallet + +
    +
    +
    +
    +
    +
    +

    Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public protocol Wallet : Decodable, Encodable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Protocols/FailWithParser.html b/Protocols/FailWithParser.html new file mode 100644 index 00000000..086d888e --- /dev/null +++ b/Protocols/FailWithParser.html @@ -0,0 +1,768 @@ + + + + FailWithParser Protocol Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FailWithParser

+
+
+ +
public protocol FailWithParser
+ +
+
+

Protocol to allow defining multiple dedicated structs, one for each dApp, that knows how to convert the specific failWith cases into more human readable error messages

+ +
+
+
+
    +
  • +
    + + + + parse(failWith:) + +
    +
    +
    +
    +
    +
    +

    Take in a failWith and return a message

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func parse(failWith: FailWith?) -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Protocols/Wallet.html b/Protocols/Wallet.html new file mode 100644 index 00000000..f708bdb0 --- /dev/null +++ b/Protocols/Wallet.html @@ -0,0 +1,907 @@ + + + + Wallet Protocol Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Wallet

+
+
+ +
public protocol Wallet : Decodable, Encodable
+ +
+
+

Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    Which underlying WalletType is the wallet using

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var type: WalletType { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The public TZ1 or TZ2 address of the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var address: String { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Sign a hex string with the wallets private key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + hex + + +
    +

    A hex encoded string, representing a forged operation payload.

    +
    +
    + + completion + + +
    +

    A completion block to run with the resulting signature, needs to be done async in order to support usecases such as signing with an external ledger.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKeyCurve() + +
    +
    +
    +
    +
    +
    +

    Query which curve the given wallet is using

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func privateKeyCurve() -> EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Base58 encoded version of the publicKey, used when performing a reveal operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func publicKeyBase58encoded() -> String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Publisher/index.html b/Publisher/index.html deleted file mode 100644 index 5dfb2069..00000000 --- a/Publisher/index.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - KukaiCoreSwift - Publisher - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - Publisher -

-
-

Methods

- -
-

- as​Future() -

-
-
func asFuture() -> Future<Output, Never>  
-
-
-

Wrap a Publisher in a Future of type <Output, Never>

- -
-
-
-

- as​Deferred​Future() -

-
-
func asDeferredFuture() -> Deferred<Future<Output, Never>>  
-
-
-

Wrap a Publisher in a Deferred Future of type <Output, Never>

- -
-
-
-

- convert​ToResult() -

-
-
func convertToResult() -> AnyPublisher<Result<Output, Failure>, Never>  
-
-
-

Convert a publisher output into a swift Resultobject to make handling sink's easier

- -
-
-
-

- on​Receive​Output(_:​) -

-
-
func onReceiveOutput(_ callback: @escaping ((Self.Output) -> Void)) -> Publishers.HandleEvents<Self>  
-
-
-

Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

- -
-
-
-

- sink(on​Error:​on​Success:​on​Complete:​) -

-
-
func sink(onError: @escaping ((Failure) -> Void), onSuccess: @escaping ((Output) -> Void), onComplete: (() -> Void)? = nil) -> AnyCancellable  
-
-
-

Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

- -
-
-
-
-
- - - - diff --git a/QuipuswapExchangeLedger/index.html b/QuipuswapExchangeLedger/index.html deleted file mode 100644 index 911dc88b..00000000 --- a/QuipuswapExchangeLedger/index.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - KukaiCoreSwift - QuipuswapExchangeLedger - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Quipuswap​Exchange​Ledger -

- -
-
public struct QuipuswapExchangeLedger: Codable  
-
-
-

The unique data inside the Ledger BigMap

- -
-
- -
- - - - - - -%67 - - - -QuipuswapExchangeLedger - - -QuipuswapExchangeLedger - - - - - -Codable - -Codable - - - -QuipuswapExchangeLedger->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- balance -

-
-
public let balance: String
-
-
-

Usable balance of the token owned

- -
-
-
-

- frozen_balance -

-
-
public let frozen_balance: String
-
-
-

Currently unaccessible balance of the token owned

- -
-
-
- - - -
-
- - - - diff --git a/QuipuswapExchangeLedgerKey/index.html b/QuipuswapExchangeLedgerKey/index.html deleted file mode 100644 index 04245628..00000000 --- a/QuipuswapExchangeLedgerKey/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - KukaiCoreSwift - QuipuswapExchangeLedgerKey - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Quipuswap​Exchange​Ledger​Key -

- -
-
public struct QuipuswapExchangeLedgerKey: Codable  
-
-
-

The gneric container object holding the raw data

- -
-
- -
- - - - - - -%475 - - - -QuipuswapExchangeLedgerKey - - -QuipuswapExchangeLedgerKey - - - - - -Codable - -Codable - - - -QuipuswapExchangeLedgerKey->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- value -

-
-
public let value: QuipuswapExchangeLedger
-
-
-
- - - -
-
- - - - diff --git a/QuipuswapExchangeLedgerKeyResponse/index.html b/QuipuswapExchangeLedgerKeyResponse/index.html deleted file mode 100644 index 05e00973..00000000 --- a/QuipuswapExchangeLedgerKeyResponse/index.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - KukaiCoreSwift - QuipuswapExchangeLedgerKeyResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Typealias - Quipuswap​Exchange​Ledger​Key​Response -

- -
-
public typealias QuipuswapExchangeLedgerKeyResponse = [QuipuswapExchangeLedgerKey] 
-
-
-

Wrapper object around the network response

- -
-
-
- - - - diff --git a/QuipuswapExchangeStorage/index.html b/QuipuswapExchangeStorage/index.html deleted file mode 100644 index 7cb84a60..00000000 --- a/QuipuswapExchangeStorage/index.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - - KukaiCoreSwift - QuipuswapExchangeStorage - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Quipuswap​Exchange​Storage -

- -
-
public struct QuipuswapExchangeStorage: Codable  
-
-
-

Unique Quipuswap contract storage object

- -
-
- -
- - - - - - -%579 - - - -QuipuswapExchangeStorage - - -QuipuswapExchangeStorage - - - - - -Codable - -Codable - - - -QuipuswapExchangeStorage->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- ledger -

-
-
public let ledger: Int
-
-
-

Ledger bigmap id

- -
-
-
-

- user_rewards -

-
-
public let user_rewards: Int
-
-
-

user rewards bigmap id

- -
-
-
-

- reward -

-
-
public let reward: String
-
-
-

The current reward

- -
-
-
-

- reward_paid -

-
-
public let reward_paid: String
-
-
-

The amount of rewards paid out

- -
-
-
-

- total_reward -

-
-
public let total_reward: String
-
-
-

Total reward

- -
-
-
-

- total_supply -

-
-
public let total_supply: String
-
-
-

Totoal supply of this token

- -
-
-
-

- period_finish -

-
-
public let period_finish: String
-
-
-

Date/Time the period will finish

- -
-
-
-

- reward_per_sec -

-
-
public let reward_per_sec: String
-
-
-

The reward per second

- -
-
-
-

- last_update_time -

-
-
public let last_update_time: String
-
-
-

Date/Time of the last recorded update to the sotrage

- -
-
-
-

- reward_per_share -

-
-
public let reward_per_share: String
-
-
-

The entitled reward per 1 share owned

- -
-
-
-
-

Methods

- -
-

- date(from:​) -

-
-
public func date(from: String) -> Date?  
-
-
-

Convert a string to a Date object using Zulu time format

- -
-
-
- - - -
-
- - - - diff --git a/QuipuswapExchangeStorageResponse/index.html b/QuipuswapExchangeStorageResponse/index.html deleted file mode 100644 index 0d2573f4..00000000 --- a/QuipuswapExchangeStorageResponse/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - KukaiCoreSwift - QuipuswapExchangeStorageResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Quipuswap​Exchange​Storage​Response -

- -
-
public struct QuipuswapExchangeStorageResponse: Codable  
-
-
-

Network wrapper object

- -
-
- -
- - - - - - -%359 - - - -QuipuswapExchangeStorageResponse - - -QuipuswapExchangeStorageResponse - - - - - -Codable - -Codable - - - -QuipuswapExchangeStorageResponse->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- storage -

-
-
public let storage: QuipuswapExchangeStorage
-
-
-
- - - -
-
- - - - diff --git a/QuipuswapExchangeUserRewards/index.html b/QuipuswapExchangeUserRewards/index.html deleted file mode 100644 index 44ea3cbc..00000000 --- a/QuipuswapExchangeUserRewards/index.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - KukaiCoreSwift - QuipuswapExchangeUserRewards - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Quipuswap​Exchange​User​Rewards -

- -
-
public struct QuipuswapExchangeUserRewards: Codable  
-
-
-

The unique data inside the User Rewards BigMap

- -
-
- -
- - - - - - -%587 - - - -QuipuswapExchangeUserRewards - - -QuipuswapExchangeUserRewards - - - - - -Codable - -Codable - - - -QuipuswapExchangeUserRewards->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- reward -

-
-
public let reward: String
-
-
-

Total reward the user has earned

- -
-
-
-

- reward_paid -

-
-
public let reward_paid: String
-
-
-

Total rewards that have been paid out to the user

- -
-
-
- - - -
-
- - - - diff --git a/QuipuswapExchangeUserRewardsKey/index.html b/QuipuswapExchangeUserRewardsKey/index.html deleted file mode 100644 index 5a8b8eff..00000000 --- a/QuipuswapExchangeUserRewardsKey/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - KukaiCoreSwift - QuipuswapExchangeUserRewardsKey - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Quipuswap​Exchange​User​Rewards​Key -

- -
-
public struct QuipuswapExchangeUserRewardsKey: Codable  
-
-
-

The gneric container object holding the raw data

- -
-
- -
- - - - - - -%509 - - - -QuipuswapExchangeUserRewardsKey - - -QuipuswapExchangeUserRewardsKey - - - - - -Codable - -Codable - - - -QuipuswapExchangeUserRewardsKey->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- value -

-
-
public let value: QuipuswapExchangeUserRewards
-
-
-
- - - -
-
- - - - diff --git a/QuipuswapExchangeUserRewardsKeyResponse/index.html b/QuipuswapExchangeUserRewardsKeyResponse/index.html deleted file mode 100644 index b6b6a84d..00000000 --- a/QuipuswapExchangeUserRewardsKeyResponse/index.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - KukaiCoreSwift - QuipuswapExchangeUserRewardsKeyResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Typealias - Quipuswap​Exchange​User​Rewards​Key​Response -

- -
-
public typealias QuipuswapExchangeUserRewardsKeyResponse = [QuipuswapExchangeUserRewardsKey] 
-
-
-

Wrapper object around the network response

- -
-
-
- - - - diff --git a/RPC/index.html b/RPC/index.html deleted file mode 100644 index 76ddbb81..00000000 --- a/RPC/index.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - KukaiCoreSwift - RPC - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - RPC -

- -
-
public class RPC<T: Decodable>  
-
-
-

A generic class representing an RPC call to the Tezos network. -A type must be passed in when creating an instance of this object, this will be used by the network layer to parse the response and detect errors.

- -
- -
-

Initializers

- -
-

- init(endpoint:​payload:​response​Type:​) -

-
-
public init(endpoint: String, payload: Data?, responseType: T.Type)  
-
-
-

Init an RPC object, to be passed to the network layer to performa request to the node.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
endpointString

The endpoint to send the request too.

-
payloadData?

An optional payload for POST requests.

-
response​TypeT.​Type

The expected response type from the network.

-
-
-
-
-

Properties

- -
-

- endpoint -

-
-
public let endpoint: String
-
-
-

The endpoint that will be added onto the TezosNodeConfig.primaryNodeURL to form a full URL for the request

- -
-
-
-

- payload -

-
-
public let payload: Data? 
-
-
-

An optional payload for sending HTTP POST requests

- -
-
-
-

- response​Type -

-
-
public let responseType: T.Type
-
-
-

The expected response type from the network

- -
-
-
-

- is​Post -

-
-
public var isPost: Bool  
-
-
-

Computed property to indicate wheter or not this is a POST request

- -
-
-
-
-

Methods

- -
-

- encodable​ToData(encodable:​) -

-
-
public static func encodableToData<T: Encodable>(encodable: T) -> Data?  
-
-
-

Helper function to wrap up JSONEncoder().encode and log any errors.

- -
-
-
- - - -
-
- - - - diff --git a/RegularWallet/index.html b/RegularWallet/index.html deleted file mode 100644 index 7f163970..00000000 --- a/RegularWallet/index.html +++ /dev/null @@ -1,421 +0,0 @@ - - - - - - KukaiCoreSwift - RegularWallet - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Regular​Wallet -

- -
-
public class RegularWallet: Wallet  
-
-
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

- -
-
-

This wallet is a non-HD wallet, sometimes referred to as a "legacy" wallet. It follows the Bip39 standard for generation via menmonic.

- -
-
- -
- - - - - - -%715 - - - -RegularWallet - - -RegularWallet - - - - - -Hashable - -Hashable - - - -RegularWallet->Hashable - - - - - -Wallet - - -Wallet - - - - - -RegularWallet->Wallet - - - - - -Equatable - -Equatable - - - -RegularWallet->Equatable - - - - - -TorusWallet - - -TorusWallet - - - - - -TorusWallet->RegularWallet - - - - - - - - -
-

Subclasses

-
-
TorusWallet
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

-
-
-

Conforms To

-
-
Wallet
-

Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

-
-
Equatable
-
Hashable
-
-
-
-

Initializers

- -
-

- init?(with​Base58String:​elliptical​Curve:​type:​) -

-
-
public init?(withBase58String: String, ellipticalCurve: EllipticalCurve, type: WalletType)  
-
-
-

Attempt to create an instance of a RegularWallet from an encoded string containing a private key

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
with​Base58StringString

String containing the Base58 encoded private key, prefixed with the curve's secret

-
elliptical​CurveElliptical​Curve

The ellipcatical curve used to create the key

-
typeWallet​Type

WalletType indicating the top most type of wallet

-
-
-
-

- init?(with​Mnemonic:​passphrase:​elliptical​Curve:​) -

-
-
public init?(withMnemonic mnemonic: Mnemonic, passphrase: String, ellipticalCurve: EllipticalCurve = .ed25519)  
-
-
-

Create a RegularWallet by supplying a Mnemonic and a passphrase (or "" if none).

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
with​MnemonicMnemonic

A Mnemonic representing a BIP39 menmonic

-
passphraseString

String contianing a passphrase, or empty string if none

-
elliptical​CurveElliptical​Curve

Optional: Choose the EllipticalCurve used to generate the wallet address

-
-
-
-

- init?(with​Mnemonic​Length:​passphrase:​elliptical​Curve:​) -

-
-
public convenience init?(withMnemonicLength length: Mnemonic.NumberOfWords, passphrase: String, ellipticalCurve: EllipticalCurve = .ed25519)  
-
-
-

Create a RegularWallet by asking for a mnemonic of a given number of words and a passphrase (or "" if none).

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
with​Mnemonic​LengthMnemonic.​Number​OfWords

Mnemonic.NumberOfWords the number of words to use when creating a mnemonic

-
passphraseString

String contianing a passphrase, or empty string if none

-
elliptical​CurveElliptical​Curve

Optional: Choose the EllipticalCurve used to generate the wallet address

-
-
-
-
-

Properties

- -
-

- type -

-
-
public let type: WalletType
-
-
-

enum used to differientate wallet class types. Needed for applications that allow users to create many different types of wallets

- -
-
-
-

- address -

-
-
public let address: String
-
-
-

The TZ1 or TZ2 address of the wallet

- -
-
-
-

- private​Key -

-
-
public var privateKey: PrivateKey
-
-
-

An object representing the PrivateKey used to generate the wallet

- -
-
-
-

- public​Key -

-
-
public var publicKey: PublicKey
-
-
-

An object representing the PublicKey used to generate the wallet address

- -
-
-
-

- mnemonic -

-
-
public var mnemonic: Mnemonic? 
-
-
-

Optional Bip39 mnemonic used to generate the wallet

- -
-
-
-
-

Methods

- -
-

- sign(_:​is​Operation:​completion:​) -

-
-
public func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))  
-
-
-

Sign a hex payload with the private key

- -
-
-
-

- private​Key​Curve() -

-
-
public func privateKeyCurve() -> EllipticalCurve  
-
-
-

Return the curve used to create the key

- -
-
-
-

- public​Key​Base58encoded() -

-
-
public func publicKeyBase58encoded() -> String  
-
-
-

Get a Base58 encoded version of the public key, in order to reveal the address on the network

- -
-
-
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: RegularWallet, rhs: RegularWallet) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/Result/index.html b/Result/index.html deleted file mode 100644 index db0dc459..00000000 --- a/Result/index.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - KukaiCoreSwift - Result - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - Result -

-
-

Methods

- -
-

- get​Error() -

-
-
func getError() throws -> Failure  
-
-
-

Similar to Result.get(), getError returns the failure case or throws

- -
-
-
-

- get​Failure() -

-
-
func getFailure() -> Failure  
-
-
-

Similar to Result.get(), getFailure returns the kukai-core-specific KukaiError case or throws

- -
-
-
-
-
- - - - diff --git a/ResultExtensionError/index.html b/ResultExtensionError/index.html deleted file mode 100644 index 74118a27..00000000 --- a/ResultExtensionError/index.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - KukaiCoreSwift - ResultExtensionError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Result​Extension​Error -

- -
-
public enum ResultExtensionError: Error  
-
-
- -
- - - - - - -%169 - - - -ResultExtensionError - - -ResultExtensionError - - - - - -Error - -Error - - - -ResultExtensionError->Error - - - - - - - - -
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- no​Error​Found -

-
-
case noErrorFound
-
-
-
- - - -
-
- - - - diff --git a/RewardDetails/index.html b/RewardDetails/index.html deleted file mode 100644 index 7a663147..00000000 --- a/RewardDetails/index.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - KukaiCoreSwift - RewardDetails - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Reward​Details -

- -
-
public struct RewardDetails: Codable  
-
-
-

An individual payment record denoting some payment in the past or future

- -
-
- -
- - - - - - -%427 - - - -RewardDetails - - -RewardDetails - - - - - -Codable - -Codable - - - -RewardDetails->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(baker​Alias:​baker​Logo:​payment​Address:​amount:​cycle:​fee:​date:​meets​Min​Delegation:​) -

-
-
public init(bakerAlias: String?, bakerLogo: URL?, paymentAddress: String, amount: XTZAmount, cycle: Int, fee: Double, date: Date, meetsMinDelegation: Bool)  
-
-
-
-
-

Properties

- -
-

- baker​Alias -

-
-
public let bakerAlias: String? 
-
-
- -
-

- payment​Address -

-
-
public let paymentAddress: String
-
-
-
-

- amount -

-
-
public let amount: XTZAmount
-
-
-
-

- cycle -

-
-
public let cycle: Int
-
-
-
-

- fee -

-
-
public let fee: Double
-
-
-
-

- date​OfPayment -

-
-
public let dateOfPayment: Date
-
-
-
-

- meets​Min​Delegation -

-
-
public let meetsMinDelegation: Bool
-
-
-
- - - -
-
- - - - diff --git a/RunOperationPayload/index.html b/RunOperationPayload/index.html deleted file mode 100644 index d1165e87..00000000 --- a/RunOperationPayload/index.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - KukaiCoreSwift - RunOperationPayload - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Run​Operation​Payload -

- -
-
public struct RunOperationPayload: Codable  
-
-
-

Payload object needed when sending operations to .../run_operation

- -
-
- -
- - - - - - -%259 - - - -RunOperationPayload - - -RunOperationPayload - - - - - -Codable - -Codable - - - -RunOperationPayload->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
- - - - -
-
- - - - diff --git a/SVGImgProcessor/index.html b/SVGImgProcessor/index.html deleted file mode 100644 index 1be77fc5..00000000 --- a/SVGImgProcessor/index.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - KukaiCoreSwift - SVGImgProcessor - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - SVGImg​Processor -

- -
-
public struct SVGImgProcessor: ImageProcessor  
-
-
-

SVG image processor for Kingfisher library

- -
-
- -
- - - - - - -%267 - - - -SVGImgProcessor - - -SVGImgProcessor - - - - - -ImageProcessor - -ImageProcessor - - - -SVGImgProcessor->ImageProcessor - - - - - - - - -
-

Conforms To

-
-
ImageProcessor
-
-
-
-

Properties

- -
-

- identifier -

-
-
public var identifier: String = "app.kukai.mobile.webpprocessor"
-
-
-
-
-

Methods

- -
-

- process(item:​options:​) -

-
-
public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage?  
-
-
-
- - - -
-
- - - - diff --git a/String/index.html b/String/index.html deleted file mode 100644 index bb50d02f..00000000 --- a/String/index.html +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - KukaiCoreSwift - String - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - String -

-
-

Methods

- -
-

- md5() -

-
-
func md5() -> String  
-
-
-

Generate an MD5 hash from the string

- -
-
-
-

- indexes​Of(string:​) -

-
-
func indexesOf(string: String) -> [String.Index]  
-
-
-

Return the starting indexes of each occurnace of the supplied string

- -
-
-
-

- remove​Leading​Protocol​From​RPCError() -

-
-
func removeLeadingProtocolFromRPCError() -> String?  
-
-
-

When an error is returned in the format proto.012-Psithaca.gas_exhausted.operation, in many cases we only care about the bit after the protocol. This function returns only that piece

- -
-
-
-
-
- - - - diff --git a/Structs.html b/Structs.html new file mode 100644 index 00000000..33cac02c --- /dev/null +++ b/Structs.html @@ -0,0 +1,3421 @@ + + + + Structures Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Structures

+

The following structures are available globally.

+ +
+
+
+
    +
  • +
    + + + + Account + +
    +
    +
    +
    +
    +
    +

    Fetching all the account balances is a lengthy task, involving many requests and parsing different structures. +This struct abstract the developer away from knowing all these details, and instead allows developers to access wallets balances in a more normal approach

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Account : Codable, Hashable
    +
    extension Account: Identifiable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object ot abstract away a significatn amount of logic involved in computing estimated reward payments from a baker

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct AggregateRewardInformation : Codable, Hashable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + RewardDetails + +
    +
    +
    +
    +
    +
    +

    An individual payment record denoting some payment in the past or future

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct RewardDetails : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A model matching the response that comes back from BetterCallDev’s API: v1/opg/<operation-hash>

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BetterCallDevOperation : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    BetterCallDev structure for errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BetterCallDevOperationError : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupChartData + +
    +
    +
    +
    +
    +
    +

    Struct to hold 4 arrays of data, each one mapping to a different timeline of data, to allow the display of graphs

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupChartData : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupChartObject + +
    +
    +
    +
    +
    +
    +

    Structure holding a data slice

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupChartObject : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper object to map to network response type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupExchangesAndTokensResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper object to map to network response type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupExchangesAndTokens : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupExchange + +
    +
    +
    +
    +
    +
    +

    A DipDup Exchange object with all the necessary pieces for checking liquidity and performing Swaps

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupExchange : Codable, Hashable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupPosition + +
    +
    +
    +
    +
    +
    +

    Wrapper object to match network response type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupPosition : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupPositionData + +
    +
    +
    +
    +
    +
    +

    A position on DipDup corresponds to liquidity token ownership. Each of these objects represents an amount of Liquidity tokens in an exchange for the given address

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupPositionData : Codable, Hashable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupToken + +
    +
    +
    +
    +
    +
    +

    DipDup representation of a Token

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupToken : Codable, Hashable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTAccount + +
    +
    +
    +
    +
    +
    +

    Model mapping to TzKT.io’s Account object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTAccount : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTAccountDelegate + +
    +
    +
    +
    +
    +
    +

    Model mapping to TzKT.io’s Account.Delegate Object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTAccountDelegate : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTAddress + +
    +
    +
    +
    +
    +
    +

    Details about a given contract

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTAddress : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBaker + +
    +
    +
    +
    +
    +
    +

    Data representing a baker from TzKT or Baking-Bad

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBaker : Codable, Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBakerConfig + +
    +
    +
    +
    +
    +
    +

    The bakers config file for details on when fees, min delegation etc change

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBakerConfig : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBakerConfigDoubleValue : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBakerConfigIntValue : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Baker config payout flags

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBakerConfigRewardStruct : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBalance + +
    +
    +
    +
    +
    +
    +

    Model mapping to the Balance object returned from the new TzKT API, resulting from the merge of BCD and TzKT

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalance : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBalanceToken + +
    +
    +
    +
    +
    +
    +

    Model encapsulating information about the token itself

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceToken : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBalanceMetadata + +
    +
    +
    +
    +
    +
    +

    Metadata object for the token

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceMetadata : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper / Helper to extract metadata attribute content

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceMetadataAttributeKeyValue : Codable, Hashable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object containing information about the various formats the media is available in

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceMetadataFormat : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object containing information about the dimensions of a given piece of media

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceMetadataDimensions : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTCycle + +
    +
    +
    +
    +
    +
    +

    The blockchain is broken down into cycles that last 2.7 days. Baker payment logic resolves around cycles instead of blocks

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTCycle : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTDelegatorReward + +
    +
    +
    +
    +
    +
    +

    An object containing info on the reward a delegator should receive from a baker

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTDelegatorReward : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTOperation + +
    +
    +
    +
    +
    +
    +

    A model matching the response that comes back from TzKT’s API: v1/operations/<operation-hash>

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTOperation : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTOperationError + +
    +
    +
    +
    +
    +
    +

    TzKT’s more basic error object response

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTOperationError : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTTokenTransfer + +
    +
    +
    +
    +
    +
    +

    FA1.2 / FA2 token transafers are treated differently from transactions. This object is used when fetching data form the API, as a temporary placeholder, ultimately to be merged into the transactions

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTTokenTransfer : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTTransaction + +
    +
    +
    +
    +
    +
    +

    A model matching the response that comes back from TzKT’s API: v1/accounts/<address>/operations

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTTransaction : Codable, CustomStringConvertible, Hashable, Identifiable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTTransactionGroup + +
    +
    +
    +
    +
    +
    +

    Artifical object used to group related transactions into a more user friendly display +For example, 1 contract call can reuslt in many transactions being returned. To avoid the users UI being clogged, we group all them into 1 group, so the user only needs to see 1 item for 1 action they performed

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTTransactionGroup : Codable, Hashable, Identifiable, CustomStringConvertible
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + BlockchainHead + +
    +
    +
    +
    +
    +
    +

    Structure representing the HEAD of the blockchain

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BlockchainHead : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LoggingConfig + +
    +
    +
    +
    +
    +
    +

    A struct to control what messages get logged

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct LoggingConfig
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosNodeClientConfig + +
    +
    +
    +
    +
    +
    +

    A configuration object used to provide settings to the TezosNodeClient

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosNodeClientConfig
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The gneric container object holding the raw data

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeLedgerKey : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The unique data inside the Ledger BigMap

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeLedger : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Network wrapper object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeStorageResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Unique Quipuswap contract storage object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeStorage : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The gneric container object holding the raw data

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeUserRewardsKey : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The unique data inside the User Rewards BigMap

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeUserRewards : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Dedicated “FailWith” parser for the codes received from Liquidity Baking contract

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct FailWithParserLiquidityBaking : FailWithParser
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + GraphQLError + +
    +
    +
    +
    +
    +
    +

    GraphQL error object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct GraphQLError : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + GraphQLResponse + +
    +
    +
    +
    +
    +
    +

    Simple model object to wrap a GraphQL response to expose a Codable response without having to use large GraphQL libraries

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct GraphQLResponse<T> : Codable where T : Decodable, T : Encodable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktCollections + +
    +
    +
    +
    +
    +
    +

    GarpQL bulk response for a group of collections

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktCollections : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktCollection + +
    +
    +
    +
    +
    +
    +

    Single collection item

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktCollection : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktCreator + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktCreator : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktTokenReponse + +
    +
    +
    +
    +
    +
    +

    GarpQL response for required data for a given token

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktTokenReponse : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktToken + +
    +
    +
    +
    +
    +
    +

    Single token item

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktToken : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktAttribute + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktAttribute : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktAttributeData + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktAttributeData : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktAttributeCounts + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktAttributeCounts : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktSale + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktSale : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktListing + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktListing : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktEvent + +
    +
    +
    +
    +
    +
    +

    Single event item

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktEvent : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktFa + +
    +
    +
    +
    +
    +
    +

    Single FA item

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktFa : Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Domain +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Response object wrapper for querying an address in bulk

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsAddressBulkResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosDomainsDomains + +
    +
    +
    +
    +
    +
    +

    Object containing an array of domains

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsDomains : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Response object wrapper for querying an address

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsAddressResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosDomainsDomain + +
    +
    +
    +
    +
    +
    +

    Domain object containing details about the domain

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsDomain : Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Reverse Record +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Response object wrapper for querying a reverse record

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsDomainResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Response object wrapper for querying a reverse record in bulk

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsDomainBulkResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object containing an array of reverse records

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsReverseRecords : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object containing all the info of the tezos domains record

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsReverseRecord : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LiquidityBakingData + +
    +
    +
    +
    +
    +
    +

    Wrapper object to hold onto all the necessary data in order to work with liquidity baking contract (swap, add or remove liqudity)

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct LiquidityBakingData : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NFT + +
    +
    +
    +
    +
    +
    +

    An indiviual NFT (not the parent token/collection) holding a URI to an asset somewhere on the internet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct NFT : Codable, Hashable
    +
    extension NFT: Identifiable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NetworkConstants + +
    +
    +
    +
    +
    +
    +

    The contants that a given Tezos node is using for block times, blakc size etc

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct NetworkConstants : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NetworkVersion + +
    +
    +
    +
    +
    +
    +

    The version of the Tezos code being run by the given node

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct NetworkVersion : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NilOnDecodingError + +
    +
    +
    +
    +
    +
    +

    property wrapper to easily handle a situation where we don’t want decoding to fail for 1 property which may be problematic. Instead just default it to nil

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    @propertyWrapper
    +public struct NilOnDecodingError<Wrapped>
    +
    extension NilOnDecodingError: Decodable where Wrapped: Decodable
    +
    extension NilOnDecodingError: Encodable where Wrapped: Encodable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationBlockHeader + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationBlockHeader : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationFees + +
    +
    +
    +
    +
    +
    +

    A structure representing all the fees, storage and computation needed to perform an Operation

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationFees : Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationMetadata + +
    +
    +
    +
    +
    +
    +

    Structure representing the metadata needed by Operation‘s in order to comply with the RPC standards

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationMetadata : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationPayload + +
    +
    +
    +
    +
    +
    +

    A structure representing the request that needs to be made when sending Opertion‘s to the RPC

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationPayload : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationResponse + +
    +
    +
    +
    +
    +
    +

    Structure representing the response returned from RPC endpoints such as .../preapply/operations

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The main content of the JSON returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseContent : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The metadata belonging to the OperationResponse

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseMetadata : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + BalanceUpdate + +
    +
    +
    +
    +
    +
    +

    Struct representing a change to the balance of the sender, destination or intermediary contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BalanceUpdate : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The inner result key from the OeprationResponse

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseResult : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Definition of the internal operation found inside OperationResponse

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseInternalOperation : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Definition of the outer Error object found inside OperationResponseInternalResult

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseInternalResultError : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FailWith + +
    +
    +
    +
    +
    +
    +

    The error string, error int (code), or micheline error object returned inside FailWith

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct FailWith : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + RunOperationPayload + +
    +
    +
    +
    +
    +
    +

    Payload object needed when sending operations to …/run_operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct RunOperationPayload : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SVGImgProcessor + +
    +
    +
    +
    +
    +
    +

    SVG image processor for Kingfisher library

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SVGImgProcessor : ImageProcessor
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationSubscription + +
    +
    +
    +
    +
    +
    +

    Object for sending a request through SignalR to listen to operations for a given account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationSubscription : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + WalletMetadataList + +
    +
    +
    +
    +
    +
    +

    Container to store groups of WalletMetadata based on type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct WalletMetadataList : Codable, Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + WalletMetadata + +
    +
    +
    +
    +
    +
    +

    Object to store UI related info about wallets, seperated from the wallet object itself to avoid issues merging together

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct WalletMetadata : Codable, Hashable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A struct to hold all the necessary calculations for a dex trade

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DexSwapCalculationResult
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A struct to hold all the necessary calculations for adding liquidity to a dex contract

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DexAddCalculationResult
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A struct to hold all the necessary calculations for removing liquidity from a dex contract

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DexRemoveCalculationResult
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + KukaiError + +
    +
    +
    +
    +
    +
    +

    A struct conforming to Error, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves. +Comes with helpers to extract meaning from RPC errors, optionally includes all the network data that caused the error for easier retrieval, and a fallback human readbale description to ensure something useful is always shown to the user.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct KukaiError : CustomStringConvertible, Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DApp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DApp
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OfflineConstants + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OfflineConstants
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + SubverifierWrapper + +
    +
    +
    +
    +
    +
    +

    SDK requires information about the verifer that can’t be stored inside the verifier, add a wrapper object to allow passing of all the data

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SubverifierWrapper
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/Account.html b/Structs/Account.html new file mode 100644 index 00000000..c64a0ae8 --- /dev/null +++ b/Structs/Account.html @@ -0,0 +1,1066 @@ + + + + Account Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Account

+
+
+ +
public struct Account : Codable, Hashable
+
extension Account: Identifiable
+ +
+
+

Fetching all the account balances is a lengthy task, involving many requests and parsing different structures. +This struct abstract the developer away from knowing all these details, and instead allows developers to access wallets balances in a more normal approach

+ +
+
+
+
    +
  • +
    + + + + walletAddress + +
    +
    +
    +
    +
    +
    +

    The wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let walletAddress: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtzBalance + +
    +
    +
    +
    +
    +
    +

    The XTZ balance of the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let xtzBalance: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokens + +
    +
    +
    +
    +
    +
    +

    All the wallets FA1.2, FA2 funginble tokens

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokens: [Token]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nfts + +
    +
    +
    +
    +
    +
    +

    All the wallets NFT’s, grouped into parent FA2 objects so they can be displayed in groups or individaully

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let nfts: [Token]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + recentNFTs + +
    +
    +
    +
    +
    +
    +

    10 most recent NFTs to hit the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var recentNFTs: [NFT]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + liquidityTokens + +
    +
    +
    +
    +
    +
    +

    All the wallets Defi, Liquidity Tokens

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let liquidityTokens: [DipDupPositionData]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    TzKT object containing baker details + status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegate: TzKTAccountDelegate?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegationLevel + +
    +
    +
    +
    +
    +
    +

    The block level that the delegate was set

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegationLevel: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(walletAddress:) + +
    +
    +
    +
    +
    +
    +

    Basic init to default properties to zero / empty, so that optionals can be avoided on a key model throughout an app

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(walletAddress: String)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Full init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(walletAddress: String, xtzBalance: XTZAmount, tokens: [Token], nfts: [Token], recentNFTs: [NFT], liquidityTokens: [DipDupPositionData], delegate: TzKTAccountDelegate?, delegationLevel: Decimal?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var id: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/AggregateRewardInformation.html b/Structs/AggregateRewardInformation.html new file mode 100644 index 00000000..22e23d72 --- /dev/null +++ b/Structs/AggregateRewardInformation.html @@ -0,0 +1,953 @@ + + + + AggregateRewardInformation Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

AggregateRewardInformation

+
+
+ +
public struct AggregateRewardInformation : Codable, Hashable, Equatable
+ +
+
+

Object ot abstract away a significatn amount of logic involved in computing estimated reward payments from a baker

+ +
+
+
+
    +
  • +
    + + + + previousReward + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let previousReward: RewardDetails?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let estimatedPreviousReward: RewardDetails?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + estimatedNextReward + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let estimatedNextReward: RewardDetails?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(previousReward: RewardDetails?, estimatedPreviousReward: RewardDetails?, estimatedNextReward: RewardDetails?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isOutOfDate() + +
    +
    +
    +
    +
    +
    +

    Creating this object involves many expensive requests, but produces a result that is valid for up to ~3 days. +This function can be used to determine if its ok to read a previous object from a cache, or if it needs to be refreshed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isOutOfDate() -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    When previousReward is present, it is possible that due to a delay in payment being received, that we may cache an object before the last payment was received +In this case, if we only relied on isOutOfDate() we would not update again for ~3 days. Both checks will be needed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func moreThan1CycleBetweenPreiousAndNext() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: AggregateRewardInformation, rhs: AggregateRewardInformation) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/BetterCallDevOperation.html b/Structs/BetterCallDevOperation.html new file mode 100644 index 00000000..ae2d8f98 --- /dev/null +++ b/Structs/BetterCallDevOperation.html @@ -0,0 +1,958 @@ + + + + BetterCallDevOperation Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevOperation

+
+
+ +
public struct BetterCallDevOperation : Codable
+ +
+
+

A model matching the response that comes back from BetterCallDev’s API: v1/opg/<operation-hash>

+ +
+
+
+
    +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    +

    An ID used by BCD

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    +

    The operation hash

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    +

    The operations numeric counter

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let counter: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    Indicating if the operation was successful, failed, backtracked etc.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let status: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    +

    Detailed error objects, also including unique smart contract errors

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errors: [BetterCallDevOperationError]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFailed() + +
    +
    +
    +
    +
    +
    +

    Helper to determine if the operation failed or not

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isFailed() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + containsError() + +
    +
    +
    +
    +
    +
    +

    Helper to check for existance of errors

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func containsError() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + moreDetailedError() + +
    +
    +
    +
    +
    +
    +

    When looking for more detailed errors through Better-Call.dev, effectively we are looking for an error containing a location and/or a with. +We already have the other bits, but only location and with can identify the specific Dexter error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func moreDetailedError() -> BetterCallDevOperationError?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/BetterCallDevOperationError.html b/Structs/BetterCallDevOperationError.html new file mode 100644 index 00000000..7ab093b3 --- /dev/null +++ b/Structs/BetterCallDevOperationError.html @@ -0,0 +1,897 @@ + + + + BetterCallDevOperationError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevOperationError

+
+
+ +
public struct BetterCallDevOperationError : Codable
+ +
+
+

BetterCallDev structure for errors

+ +
+
+
+
    +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + title + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let title: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + descr + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let descr: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + kind + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let kind: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + location + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let location: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + with + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let with: String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/BlockchainHead.html b/Structs/BlockchainHead.html new file mode 100644 index 00000000..8d977726 --- /dev/null +++ b/Structs/BlockchainHead.html @@ -0,0 +1,822 @@ + + + + BlockchainHead Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BlockchainHead

+
+
+ +
public struct BlockchainHead : Codable
+ +
+
+

Structure representing the HEAD of the blockchain

+ +
+
+
+
    +
  • +
    + + + + protocol + +
    +
    +
    +
    +
    +
    +

    The current protocol version string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let `protocol`: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + chainID + +
    +
    +
    +
    +
    +
    +

    The current chainID being used

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let chainID: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    +

    The current hash or branch being used

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/DexAddCalculationResult.html b/Structs/DexAddCalculationResult.html new file mode 100644 index 00000000..ef5854c8 --- /dev/null +++ b/Structs/DexAddCalculationResult.html @@ -0,0 +1,871 @@ + + + + DexAddCalculationResult Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DexAddCalculationResult

+
+
+ +
public struct DexAddCalculationResult
+ +
+
+

A struct to hold all the necessary calculations for adding liquidity to a dex contract

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/DexRemoveCalculationResult.html b/Structs/DexRemoveCalculationResult.html new file mode 100644 index 00000000..ff731814 --- /dev/null +++ b/Structs/DexRemoveCalculationResult.html @@ -0,0 +1,897 @@ + + + + DexRemoveCalculationResult Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DexRemoveCalculationResult

+
+
+ +
public struct DexRemoveCalculationResult
+ +
+
+

A struct to hold all the necessary calculations for removing liquidity from a dex contract

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/DexSwapCalculationResult.html b/Structs/DexSwapCalculationResult.html new file mode 100644 index 00000000..d0c4a55e --- /dev/null +++ b/Structs/DexSwapCalculationResult.html @@ -0,0 +1,871 @@ + + + + DexSwapCalculationResult Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DexSwapCalculationResult

+
+
+ +
public struct DexSwapCalculationResult
+ +
+
+

A struct to hold all the necessary calculations for a dex trade

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/DipDupChartData.html b/Structs/DipDupChartData.html new file mode 100644 index 00000000..449e416f --- /dev/null +++ b/Structs/DipDupChartData.html @@ -0,0 +1,849 @@ + + + + DipDupChartData Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupChartData

+
+
+ +
public struct DipDupChartData : Codable
+ +
+
+

Struct to hold 4 arrays of data, each one mapping to a different timeline of data, to allow the display of graphs

+ +
+
+
+
    +
  • +
    + + + + quotes15mNogaps + +
    +
    +
    +
    +
    +
    +

    Contains the last 24 hours of data at 15 min intervals

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let quotes15mNogaps: [DipDupChartObject]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + quotes1hNogaps + +
    +
    +
    +
    +
    +
    +

    Contains every hour for past 7 days

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let quotes1hNogaps: [DipDupChartObject]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + quotes1dNogaps + +
    +
    +
    +
    +
    +
    +

    Contains every day for 30 days

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let quotes1dNogaps: [DipDupChartObject]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + quotes1wNogaps + +
    +
    +
    +
    +
    +
    +

    Contains every week for 52 weeks

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let quotes1wNogaps: [DipDupChartObject]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/DipDupChartObject.html b/Structs/DipDupChartObject.html new file mode 100644 index 00000000..049a5542 --- /dev/null +++ b/Structs/DipDupChartObject.html @@ -0,0 +1,984 @@ + + + + DipDupChartObject Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupChartObject

+
+
+ +
public struct DipDupChartObject : Codable
+ +
+
+

Structure holding a data slice

+ +
+
+
+
    +
  • +
    + + + + average + +
    +
    +
    +
    +
    +
    +

    The average price at the given time

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let average: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchangeId + +
    +
    +
    +
    +
    +
    +

    The address of the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let exchangeId: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bucket + +
    +
    +
    +
    +
    +
    +

    String representing the date and time the slice is for

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bucket: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + high + +
    +
    +
    +
    +
    +
    +

    The highest value reached in this slice

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let high: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + low + +
    +
    +
    +
    +
    +
    +

    The lowest value reached in this slice

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let low: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + date() + +
    +
    +
    +
    +
    +
    +

    Convert the bucket string into a Date object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func date() -> Date?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + averageDouble() + +
    +
    +
    +
    +
    +
    +

    Convert the average value into a Double

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func averageDouble() -> Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + highDouble() + +
    +
    +
    +
    +
    +
    +

    Convert the high value into a Double

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func highDouble() -> Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lowDouble() + +
    +
    +
    +
    +
    +
    +

    Convert the low value into a Double

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func lowDouble() -> Double
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/DipDupExchange.html b/Structs/DipDupExchange.html new file mode 100644 index 00000000..026b397d --- /dev/null +++ b/Structs/DipDupExchange.html @@ -0,0 +1,1132 @@ + + + + DipDupExchange Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupExchange

+
+
+ +
public struct DipDupExchange : Codable, Hashable, Equatable
+ +
+
+

A DipDup Exchange object with all the necessary pieces for checking liquidity and performing Swaps

+ +
+
+
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    Enum to denote the type of Exchange (e.g. Liquidity Baking, Quipuswap)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: DipDupExchangeName
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The KT address of the exchange contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tezPool + +
    +
    +
    +
    +
    +
    +

    String representation of the Exchanges TezPool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tezPool: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenPool + +
    +
    +
    +
    +
    +
    +

    String representation of the Exchanges TokenPool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenPool: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + sharesTotal + +
    +
    +
    +
    +
    +
    +

    The total liquidity available (RPC representation, no decimals)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let sharesTotal: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + midPrice + +
    +
    +
    +
    +
    +
    +

    The daily middle price

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let midPrice: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The token object containing all the token info (decimals, contract address, symbol etc,)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token: DipDupToken
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Helper functions +

+
+
+
    +
  • +
    + + + + xtzPoolAmount() + +
    +
    +
    +
    +
    +
    +

    Return the XTZ pool as an XTZAmount object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzPoolAmount() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenPoolAmount() + +
    +
    +
    +
    +
    +
    +

    Return the Token pool as an TokenAmount object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenPoolAmount() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Retrieving the liquidity token decimals is currently not supported. Hardcode the numbers for now

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func liquidityTokenDecimalPlaces() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + totalLiquidity() + +
    +
    +
    +
    +
    +
    +

    Return the total liquidity as an TokenAmount object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func totalLiquidity() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + arePoolsEmpty() + +
    +
    +
    +
    +
    +
    +

    Helper to detect if the pools are empty (determiens if the next addLiquidity will be setting the exchange rate)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func arePoolsEmpty() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: DipDupExchange, rhs: DipDupExchange) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/DipDupExchangesAndTokens.html b/Structs/DipDupExchangesAndTokens.html new file mode 100644 index 00000000..a9c88e18 --- /dev/null +++ b/Structs/DipDupExchangesAndTokens.html @@ -0,0 +1,872 @@ + + + + DipDupExchangesAndTokens Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupExchangesAndTokens

+
+
+ +
public struct DipDupExchangesAndTokens : Codable
+ +
+
+

Wrapper object to map to network response type

+ +
+
+
+
    +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenId: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchanges + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let exchanges: [DipDupExchange]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the total XTZ pool amount from all the exchanges, useful for sorting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func totalExchangeXtzPool() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/DipDupExchangesAndTokensResponse.html b/Structs/DipDupExchangesAndTokensResponse.html new file mode 100644 index 00000000..1e24e9ca --- /dev/null +++ b/Structs/DipDupExchangesAndTokensResponse.html @@ -0,0 +1,767 @@ + + + + DipDupExchangesAndTokensResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupExchangesAndTokensResponse

+
+
+ +
public struct DipDupExchangesAndTokensResponse : Codable
+ +
+
+

Wrapper object to map to network response type

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/DipDupPosition.html b/Structs/DipDupPosition.html new file mode 100644 index 00000000..2bdde5bb --- /dev/null +++ b/Structs/DipDupPosition.html @@ -0,0 +1,767 @@ + + + + DipDupPosition Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupPosition

+
+
+ +
public struct DipDupPosition : Codable
+ +
+
+

Wrapper object to match network response type

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/DipDupPositionData.html b/Structs/DipDupPositionData.html new file mode 100644 index 00000000..f1cd6f0b --- /dev/null +++ b/Structs/DipDupPositionData.html @@ -0,0 +1,876 @@ + + + + DipDupPositionData Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupPositionData

+
+
+ +
public struct DipDupPositionData : Codable, Hashable, Equatable
+ +
+
+

A position on DipDup corresponds to liquidity token ownership. Each of these objects represents an amount of Liquidity tokens in an exchange for the given address

+ +
+
+
+
    +
  • +
    + + + + sharesQty + +
    +
    +
    +
    +
    +
    +

    The liquidity token balance (rpc representation)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let sharesQty: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchange + +
    +
    +
    +
    +
    +
    +

    The exchange the token belongs too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let exchange: DipDupExchange
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenAmount() + +
    +
    +
    +
    +
    +
    +

    Convert the token data into a TokenAmount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenAmount() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: DipDupPositionData, rhs: DipDupPositionData) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/DipDupToken.html b/Structs/DipDupToken.html new file mode 100644 index 00000000..37ae82f0 --- /dev/null +++ b/Structs/DipDupToken.html @@ -0,0 +1,930 @@ + + + + DipDupToken Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupToken

+
+
+ +
public struct DipDupToken : Codable, Hashable, Equatable
+ +
+
+

DipDup representation of a Token

+ +
+
+
+
    +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    +

    The user facing symbol of the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The TZ address of the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    +

    The token ID of the token (always 0 for FA1.2 tokens)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenId: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimals + +
    +
    +
    +
    +
    +
    +

    The number of decimals for the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let decimals: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + standard + +
    +
    +
    +
    +
    +
    +

    Which standard the token follows

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let standard: DipDupTokenStandard
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: DipDupToken, rhs: DipDupToken) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/FailWith.html b/Structs/FailWith.html new file mode 100644 index 00000000..732c2388 --- /dev/null +++ b/Structs/FailWith.html @@ -0,0 +1,871 @@ + + + + FailWith Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FailWith

+
+
+ +
public struct FailWith : Codable, Equatable
+ +
+
+

The error string, error int (code), or micheline error object returned inside FailWith

+ +
+
+
+
    +
  • +
    + + + + string + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let string: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + int + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let int: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + args + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let args: [[String : String]]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(string: String?, int: String?, args: [[String : String]]?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/FailWithParserLiquidityBaking.html b/Structs/FailWithParserLiquidityBaking.html new file mode 100644 index 00000000..b6f65b80 --- /dev/null +++ b/Structs/FailWithParserLiquidityBaking.html @@ -0,0 +1,767 @@ + + + + FailWithParserLiquidityBaking Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FailWithParserLiquidityBaking

+
+
+ +
public struct FailWithParserLiquidityBaking : FailWithParser
+ +
+
+

Dedicated “FailWith” parser for the codes received from Liquidity Baking contract

+ +
+
+
+
    +
  • +
    + + + + parse(failWith:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parse(failWith: FailWith?) -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/GraphQLError.html b/Structs/GraphQLError.html new file mode 100644 index 00000000..7b39d499 --- /dev/null +++ b/Structs/GraphQLError.html @@ -0,0 +1,822 @@ + + + + GraphQLError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

GraphQLError

+
+
+ +
public struct GraphQLError : Codable
+ +
+
+

GraphQL error object

+ +
+
+
+
    +
  • +
    + + + + message + +
    +
    +
    +
    +
    +
    +

    Message sent from the server explaining the issue

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let message: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + locations + +
    +
    +
    +
    +
    +
    +

    Identifying the location fo the issue. E.g. codefile and line, or location of unexpected character/symbol in request string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let locations: [String : String]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + extenstions + +
    +
    +
    +
    +
    +
    +

    Not sure, but it shows up sometimes

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let extenstions: [String : String]?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/GraphQLResponse.html b/Structs/GraphQLResponse.html new file mode 100644 index 00000000..fff77186 --- /dev/null +++ b/Structs/GraphQLResponse.html @@ -0,0 +1,795 @@ + + + + GraphQLResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

GraphQLResponse

+
+
+ +
public struct GraphQLResponse<T> : Codable where T : Decodable, T : Encodable
+ +
+
+

Simple model object to wrap a GraphQL response to expose a Codable response without having to use large GraphQL libraries

+ +
+
+
+
    +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    +

    Array of errors returned from the server

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errors: [GraphQLError]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + data + +
    +
    +
    +
    +
    +
    +

    Generic data type matching the user supplied type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let data: T?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/KukaiError.html b/Structs/KukaiError.html new file mode 100644 index 00000000..c49e21f8 --- /dev/null +++ b/Structs/KukaiError.html @@ -0,0 +1,1347 @@ + + + + KukaiError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

KukaiError

+
+
+ +
public struct KukaiError : CustomStringConvertible, Error
+ +
+
+

A struct conforming to Error, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves. +Comes with helpers to extract meaning from RPC errors, optionally includes all the network data that caused the error for easier retrieval, and a fallback human readbale description to ensure something useful is always shown to the user.

+ +
+
+
+
    +
  • +
    + + + + ErrorType + +
    +
    +
    +
    +
    +
    +

    Categories of errors that are possible

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum ErrorType : Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errorType + +
    +
    +
    +
    +
    +
    +

    The error category

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errorType: ErrorType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + knownErrorMessage + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let knownErrorMessage: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + subType + +
    +
    +
    +
    +
    +
    +

    Optional error subType coming from another source (the OS, URLSession, another library etc)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let subType: Error?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + rpcErrorString + +
    +
    +
    +
    +
    +
    +

    Optional string containing only the relvant portion of an RPC error (e.g instead of “proto.xxxxxxxx.gas_exhausted.operation”, it would contain “gas_exhausted.operation”) to make parsing easier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let rpcErrorString: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + failWith + +
    +
    +
    +
    +
    +
    +

    Optional object containing smart contract failure casues. May contain an Int (error code), a String (semi human readbale error message), and/or a dictionary containing metadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let failWith: FailWith?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + requestURL + +
    +
    +
    +
    +
    +
    +

    The requested URL that returned the error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var requestURL: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + requestJSON + +
    +
    +
    +
    +
    +
    +

    The JSON that was sent as part of the request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var requestJSON: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + responseJSON + +
    +
    +
    +
    +
    +
    +

    The raw JSON that was returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var responseJSON: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + httpStatusCode + +
    +
    +
    +
    +
    +
    +

    The HTTP status code returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var httpStatusCode: Int?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Constructors +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a KukaiError from an RPC string (will not be validated). You can use the string extension .removeLeadingProtocolFromRPCError() to strip the leading poriton of the error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func rpcError(rpcErrorString: String, andFailWith: FailWith?) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + systemError(subType:) + +
    +
    +
    +
    +
    +
    +

    Create a KukaiError denoting a sytem issue from the OS, by passing in the system Error type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func systemError(subType: Error) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a KukaiError denoting a network issue, by passing in the HTTP status code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func networkError(statusCode: Int, requestURL: URL) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a KukaiError denoting an issue from some other component or library, by passing in the error that piece of code returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func internalApplicationError(error: Error) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decodingError(error:) + +
    +
    +
    +
    +
    +
    +

    Create a KukaiError denoting an issue from some other component or library, by passing in the error that piece of code returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func decodingError(error: Error) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + knownErrorMessage(_:) + +
    +
    +
    +
    +
    +
    +

    Create a KukaiError allowing a client to simply provide the required error message. +E.g. In situations where GraphQL returns a malformed object instead of an error, resulting in a decodingError, a client can catch that, supress it, and instead reutrn an error explaining that this record couldn’t be found

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func knownErrorMessage(_ message: String) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown(withString:) + +
    +
    +
    +
    +
    +
    +

    Create an unknown KukaiError

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func unknown(withString: String? = nil) -> KukaiError
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Modifiers +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    For network errors, attach all the necessary network data that may be needed in order to debug the issue, or log to a tool such as sentry

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func addNetworkData(requestURL: URL?, requestJSON: Data?, responseJSON: Data?, httpStatusCode: Int?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Display +

+
+
+
    +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Prints the underlying error type with either an RPC string, or an underlying Error object contents

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func checkErrorForKnownCase(_ err: Error) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func messageForNetworkStatusCode(statusCode: Int, url: URL) -> String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/KukaiError/ErrorType.html b/Structs/KukaiError/ErrorType.html new file mode 100644 index 00000000..2645435e --- /dev/null +++ b/Structs/KukaiError/ErrorType.html @@ -0,0 +1,930 @@ + + + + ErrorType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ErrorType

+
+
+ +
public enum ErrorType : Equatable
+ +
+
+

Categories of errors that are possible

+ +
+
+
+
    +
  • +
    + + + + rpc + +
    +
    +
    +
    +
    +
    +

    RPC errors come directly from the Tezos RPC, but with the massive JSON object filtered down to the most meraningful part

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case rpc
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + system + +
    +
    +
    +
    +
    +
    +

    System errors are ones coming from the OS, e.g. “No internet connection”

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case system
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + network(_:) + +
    +
    +
    +
    +
    +
    +

    Network errors are returned by a server, such as HTTP 404’s and 500’s

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case network(Int)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + internalApplication + +
    +
    +
    +
    +
    +
    +

    Internal application errors are errors from other services, components, libraiers etc, wrapped up so that they don’t require extra parsing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case internalApplication
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decodingError + +
    +
    +
    +
    +
    +
    +

    For situations where the wrong model is returned. This can happen sometimes unexpectedily in GraphQL based APIs, instead of returning an error, it will just return a partial object missing non-optional fields

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case decodingError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + knownError + +
    +
    +
    +
    +
    +
    +

    For clients to catch known errors, sometimes handled in odd ways, enabling the easy return of a String. E.g. GraphQL throwing a malformed object response for a situation that should be a 404

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case knownError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    +

    Used as a fallback for strange edge cases where we can’t easily idenitfiy the issue

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/LiquidityBakingData.html b/Structs/LiquidityBakingData.html new file mode 100644 index 00000000..3c26e415 --- /dev/null +++ b/Structs/LiquidityBakingData.html @@ -0,0 +1,876 @@ + + + + LiquidityBakingData Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LiquidityBakingData

+
+
+ +
public struct LiquidityBakingData : Codable
+ +
+
+

Wrapper object to hold onto all the necessary data in order to work with liquidity baking contract (swap, add or remove liqudity)

+ +
+
+
+
    +
  • +
    + + + + xtzPool + +
    +
    +
    +
    +
    +
    +

    The total amount of XTZ in the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let xtzPool: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenPool + +
    +
    +
    +
    +
    +
    +

    The total amount of the token in the contract (currently tzBTC)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenPool: TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + totalLiquidity + +
    +
    +
    +
    +
    +
    +

    The total amount of liquidity tokens in circulation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let totalLiquidity: TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenContractAddress + +
    +
    +
    +
    +
    +
    +

    The address of the dex contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenContractAddress: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The address of the liquidty token contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let liquidityTokenContractAddress: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/LoggingConfig.html b/Structs/LoggingConfig.html new file mode 100644 index 00000000..184f02a6 --- /dev/null +++ b/Structs/LoggingConfig.html @@ -0,0 +1,803 @@ + + + + LoggingConfig Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LoggingConfig

+
+
+ +
public struct LoggingConfig
+ +
+
+

A struct to control what messages get logged

+ +
+
+
+
+ + +
+ +

Functions +

+
+
+
    +
  • +
    + + + + allOff() + +
    +
    +
    +
    +
    +
    +

    Turn off all logging

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func allOff()
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allOn() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func allOn()
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/NFT.html b/Structs/NFT.html new file mode 100644 index 00000000..8bb6c09e --- /dev/null +++ b/Structs/NFT.html @@ -0,0 +1,1327 @@ + + + + NFT Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NFT

+
+
+ +
public struct NFT : Codable, Hashable
+
extension NFT: Identifiable
+ +
+
+

An indiviual NFT (not the parent token/collection) holding a URI to an asset somewhere on the internet

+ +
+
+
+
    +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    +

    Each NFT of a token has a unique ID

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenId: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + duplicateID + +
    +
    +
    +
    +
    +
    +

    In order to display in a tablview, the element must be hashable. But in cases where you want to show duplciates (e.g. recents), the computed hash needs to be slightly different +This property can be used as a quick hack a copy of the NFT struct slightly different, without affecting the data

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var duplicateID: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parentContract + +
    +
    +
    +
    +
    +
    +

    The address of the FA2 contract that created this NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parentContract: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parentAlias + +
    +
    +
    +
    +
    +
    +

    The human readable alias of the parent contract (e.g. “Mooncakes”)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parentAlias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + faVersion + +
    +
    +
    +
    +
    +
    +

    The FaVersion of the token contrac

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let faVersion: FaVersion
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimalPlaces + +
    +
    +
    +
    +
    +
    +

    Get the underlying number of decimal places that this token represents

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimalPlaces: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    Number of duplicate items of this NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    Human readbale name (e.g. “Tezos”)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    +

    Human readbale symbol (e.g. “XTZ”)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Human readable description (e.g. “This NFT was created too…”)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let description: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + artifactURI + +
    +
    +
    +
    +
    +
    +

    A URI to the asset the NFT is controlling ownership of

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let artifactURI: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + displayURI + +
    +
    +
    +
    +
    +
    +

    A URI used to display media of the artifact

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let displayURI: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + thumbnailURI + +
    +
    +
    +
    +
    +
    +

    A smaller thumbnail used to display meda of the artifact

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let thumbnailURI: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Metadata object containing useful information about the nft and its contents

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var metadata: TzKTBalanceMetadata?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isHidden + +
    +
    +
    +
    +
    +
    +

    Recording if the user has marked the token as hidden

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isHidden: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + favouriteSortIndex + +
    +
    +
    +
    +
    +
    +

    Recording if the position the index the user chose for the favourite token to appear

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var favouriteSortIndex: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFavourite + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isFavourite: Bool { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a more developer friednly NFT from a generic TzKTBalance object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(fromTzKTBalance tzkt: TzKTBalance)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromTzKTBalance + + +
    +

    An instance of TzKTBalance containing data about an NFT

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Confomring to Equatable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: NFT, rhs: NFT) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var id: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/NetworkConstants.html b/Structs/NetworkConstants.html new file mode 100644 index 00000000..a0b738a1 --- /dev/null +++ b/Structs/NetworkConstants.html @@ -0,0 +1,1105 @@ + + + + NetworkConstants Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkConstants

+
+
+ +
public struct NetworkConstants : Codable
+ +
+
+

The contants that a given Tezos node is using for block times, blakc size etc

+ +
+
+
+
    +
  • +
    + + + + minimal_block_delay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let minimal_block_delay: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hard_gas_limit_per_operation: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hard_gas_limit_per_block: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + origination_size + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let origination_size: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + cost_per_byte + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cost_per_byte: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hard_storage_limit_per_operation: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func secondsBetweenBlocks() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mutezPerByte() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func mutezPerByte() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtzPerByte() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzPerByte() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + maxGasPerOperation() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func maxGasPerOperation() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + maxGasPerBlock() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func maxGasPerBlock() -> Int
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func maxStoragePerOperation() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bytesForReveal() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func bytesForReveal() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtzForReveal() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzForReveal() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/NetworkVersion.html b/Structs/NetworkVersion.html new file mode 100644 index 00000000..8791712a --- /dev/null +++ b/Structs/NetworkVersion.html @@ -0,0 +1,819 @@ + + + + NetworkVersion Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkVersion

+
+
+ +
public struct NetworkVersion : Codable
+ +
+
+

The version of the Tezos code being run by the given node

+ +
+
+
+
    +
  • +
    + + + + chainName_mainnet + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let chainName_mainnet: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + chainName() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func chainName() -> String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isMainnet() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isMainnet() -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/NilOnDecodingError.html b/Structs/NilOnDecodingError.html new file mode 100644 index 00000000..dabd6b5f --- /dev/null +++ b/Structs/NilOnDecodingError.html @@ -0,0 +1,874 @@ + + + + NilOnDecodingError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NilOnDecodingError

+
+
+ +
@propertyWrapper
+public struct NilOnDecodingError<Wrapped>
+
extension NilOnDecodingError: Decodable where Wrapped: Decodable
+
extension NilOnDecodingError: Encodable where Wrapped: Encodable
+ +
+
+

property wrapper to easily handle a situation where we don’t want decoding to fail for 1 property which may be problematic. Instead just default it to nil

+ +
+
+
+
    +
  • +
    + + + + init(wrappedValue:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wrappedValue: Wrapped?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + wrappedValue + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var wrappedValue: Wrapped?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Wrapped: Decodable +

+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Wrapped: Encodable +

+
+
+
    +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktAttribute.html b/Structs/ObjktAttribute.html new file mode 100644 index 00000000..77d5c7be --- /dev/null +++ b/Structs/ObjktAttribute.html @@ -0,0 +1,766 @@ + + + + ObjktAttribute Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktAttribute

+
+
+ +
public struct ObjktAttribute : Codable
+ +
+
+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/ObjktAttributeCounts.html b/Structs/ObjktAttributeCounts.html new file mode 100644 index 00000000..3e964f98 --- /dev/null +++ b/Structs/ObjktAttributeCounts.html @@ -0,0 +1,766 @@ + + + + ObjktAttributeCounts Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktAttributeCounts

+
+
+ +
public struct ObjktAttributeCounts : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + editions + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let editions: Decimal
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktAttributeData.html b/Structs/ObjktAttributeData.html new file mode 100644 index 00000000..1916bdc1 --- /dev/null +++ b/Structs/ObjktAttributeData.html @@ -0,0 +1,818 @@ + + + + ObjktAttributeData Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktAttributeData

+
+
+ +
public struct ObjktAttributeData : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + attribute_counts + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let attribute_counts: [ObjktAttributeCounts]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktCollection.html b/Structs/ObjktCollection.html new file mode 100644 index 00000000..78e51283 --- /dev/null +++ b/Structs/ObjktCollection.html @@ -0,0 +1,1053 @@ + + + + ObjktCollection Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktCollection

+
+
+ +
public struct ObjktCollection : Codable
+ +
+
+

Single collection item

+ +
+
+
+
    +
  • +
    + + + + contract + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contract: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + logo + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let logo: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + floor_price + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let floor_price: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let twitter: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + website + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let website: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + owners + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let owners: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + editions + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let editions: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + creator + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let creator: ObjktCreator?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + websiteURL() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func websiteURL() -> URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitterURL() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func twitterURL() -> URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + floorPrice() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func floorPrice() -> XTZAmount?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktCollections.html b/Structs/ObjktCollections.html new file mode 100644 index 00000000..0b4b94ce --- /dev/null +++ b/Structs/ObjktCollections.html @@ -0,0 +1,767 @@ + + + + ObjktCollections Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktCollections

+
+
+ +
public struct ObjktCollections : Codable
+ +
+
+

GarpQL bulk response for a group of collections

+ +
+
+
+
    +
  • +
    + + + + fa + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fa: [ObjktCollection]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktCreator.html b/Structs/ObjktCreator.html new file mode 100644 index 00000000..93c10c3b --- /dev/null +++ b/Structs/ObjktCreator.html @@ -0,0 +1,844 @@ + + + + ObjktCreator Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktCreator

+
+
+ +
public struct ObjktCreator : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + alias + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let alias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + webiste + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let webiste: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let twitter: String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktEvent.html b/Structs/ObjktEvent.html new file mode 100644 index 00000000..b6eb0900 --- /dev/null +++ b/Structs/ObjktEvent.html @@ -0,0 +1,767 @@ + + + + ObjktEvent Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktEvent

+
+
+ +
public struct ObjktEvent : Codable
+ +
+
+

Single event item

+ +
+
+
+
    +
  • +
    + + + + price_xtz + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let price_xtz: Decimal?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktFa.html b/Structs/ObjktFa.html new file mode 100644 index 00000000..cd384e8e --- /dev/null +++ b/Structs/ObjktFa.html @@ -0,0 +1,793 @@ + + + + ObjktFa Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktFa

+
+
+ +
public struct ObjktFa : Codable
+ +
+
+

Single FA item

+ +
+
+
+
    +
  • +
    + + + + editions + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let editions: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + floor_price + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let floor_price: Decimal?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktListing.html b/Structs/ObjktListing.html new file mode 100644 index 00000000..35e11ad8 --- /dev/null +++ b/Structs/ObjktListing.html @@ -0,0 +1,792 @@ + + + + ObjktListing Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktListing

+
+
+ +
public struct ObjktListing : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + seller_address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let seller_address: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + price_xtz + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let price_xtz: Decimal?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktSale.html b/Structs/ObjktSale.html new file mode 100644 index 00000000..a4dadba3 --- /dev/null +++ b/Structs/ObjktSale.html @@ -0,0 +1,792 @@ + + + + ObjktSale Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktSale

+
+
+ +
public struct ObjktSale : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + price_xtz + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let price_xtz: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktToken.html b/Structs/ObjktToken.html new file mode 100644 index 00000000..2e859a4c --- /dev/null +++ b/Structs/ObjktToken.html @@ -0,0 +1,923 @@ + + + + ObjktToken Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktToken

+
+
+ +
public struct ObjktToken : Codable
+ +
+
+

Single token item

+ +
+
+
+
    +
  • +
    + + + + highest_offer + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let highest_offer: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lowest_ask + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let lowest_ask: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let metadata: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + attributes + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let attributes: [ObjktAttribute]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + listing_sales + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let listing_sales: [ObjktSale]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + listings_active + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let listings_active: [ObjktListing]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/ObjktTokenReponse.html b/Structs/ObjktTokenReponse.html new file mode 100644 index 00000000..1a6e6614 --- /dev/null +++ b/Structs/ObjktTokenReponse.html @@ -0,0 +1,923 @@ + + + + ObjktTokenReponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktTokenReponse

+
+
+ +
public struct ObjktTokenReponse : Codable
+ +
+
+

GarpQL response for required data for a given token

+ +
+
+
+
    +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token: [ObjktToken]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + event + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let event: [ObjktEvent]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fa + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fa: [ObjktFa]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isOnSale() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isOnSale() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + onSalePrice() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func onSalePrice() -> XTZAmount?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lastSalePrice() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func lastSalePrice() -> XTZAmount?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + floorPrice() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func floorPrice() -> XTZAmount?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/OperationBlockHeader.html b/Structs/OperationBlockHeader.html new file mode 100644 index 00000000..bded7cda --- /dev/null +++ b/Structs/OperationBlockHeader.html @@ -0,0 +1,1131 @@ + + + + OperationBlockHeader Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationBlockHeader

+
+
+ +
public struct OperationBlockHeader : Codable, Equatable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proto + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let proto: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + predecessor + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let predecessor: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: Date
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + validationPass + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let validationPass: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationsHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operationsHash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fitness + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fitness: [String]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + context + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let context: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + priority + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let priority: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proofOfWorkNonce + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let proofOfWorkNonce: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + seedNonceHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let seedNonceHash: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + signature + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let signature: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(level: Int, proto: Int, predecessor: String, timestamp: Date, validationPass: Int, operationsHash: String, fitness: [String], context: String, priority: Int, proofOfWorkNonce: String, seedNonceHash: String?, signature: String)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CodingKeys + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum CodingKeys : String, CodingKey
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/OperationBlockHeader/CodingKeys.html b/Structs/OperationBlockHeader/CodingKeys.html new file mode 100644 index 00000000..60b97b79 --- /dev/null +++ b/Structs/OperationBlockHeader/CodingKeys.html @@ -0,0 +1,1052 @@ + + + + CodingKeys Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

CodingKeys

+
+
+ +
public enum CodingKeys : String, CodingKey
+ +
+
+ +
+
+
+
    +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case level
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proto + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case proto
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + predecessor + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case predecessor
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case timestamp
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + validationPass + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case validationPass = "validation_pass"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationsHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case operationsHash = "operations_hash"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fitness + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fitness
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + context + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case context
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + priority + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case priority
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proofOfWorkNonce + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case proofOfWorkNonce = "proof_of_work_nonce"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + seedNonceHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case seedNonceHash = "seed_nonce_hash"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + signature + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case signature
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/OperationFees.html b/Structs/OperationFees.html new file mode 100644 index 00000000..6db0d482 --- /dev/null +++ b/Structs/OperationFees.html @@ -0,0 +1,1037 @@ + + + + OperationFees Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationFees

+
+
+ +
public struct OperationFees : Equatable
+ +
+
+

A structure representing all the fees, storage and computation needed to perform an Operation

+ +
+
+
+
    +
  • +
    + + + + NetworkFeeType + +
    +
    +
    +
    +
    +
    +

    Enum to differentiate different types of extra fees. Such as allocation fees when sending to a currently unrevealed account.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum NetworkFeeType : String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + transactionFee + +
    +
    +
    +
    +
    +
    +

    The transaction fee that the sender is willing to pay in order to perform the Operation. +Strictly speaking operations don’t have a fee, but a gas cost, and fees and offered by the user instead. +Practically, bakers will prioritsie Operation‘s with higher fees. Resulting in default feePerGas rate being required in order to get a transaction through.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var transactionFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkFees + +
    +
    +
    +
    +
    +
    +

    Additional fees the account will have to pay in order to send this operation. Such as allocating space for an unrevealed account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var networkFees: [NetworkFeeType : XTZAmount]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + gasLimit + +
    +
    +
    +
    +
    +
    +

    The limit of gas (computation + CPU) this Operation should take. If it exceeds this value when running, the Operation will fail.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var gasLimit: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + storageLimit + +
    +
    +
    +
    +
    +
    +

    The limit of storage (disk) this Operation requires to complete. If it exceeds this value when running, the Operation will fail.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var storageLimit: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allFees() + +
    +
    +
    +
    +
    +
    +

    Add together all the network fees and transaction fees

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func allFees() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allNetworkFees() + +
    +
    +
    +
    +
    +
    +

    Add together all the network fees and transaction fees

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func allNetworkFees() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + zero() + +
    +
    +
    +
    +
    +
    +

    Creates an OperationFees object, with everything set to zero. Primarly used as a default / placeholder until an estimation can be performed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func zero() -> OperationFees
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a default fees for each type of Operation. No guarentee these will succeed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func defaultFees(operationKind: OperationKind) -> OperationFees
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + operationKind + + +
    +

    enum to denote the type of Operation

    +
    +
    +
    +
    +

    Return Value

    +

    a OperationFees object with all the values set.

    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Confirming to Equatable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: OperationFees, rhs: OperationFees) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/OperationFees/NetworkFeeType.html b/Structs/OperationFees/NetworkFeeType.html new file mode 100644 index 00000000..2e6ae629 --- /dev/null +++ b/Structs/OperationFees/NetworkFeeType.html @@ -0,0 +1,793 @@ + + + + NetworkFeeType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkFeeType

+
+
+ +
public enum NetworkFeeType : String
+ +
+
+

Enum to differentiate different types of extra fees. Such as allocation fees when sending to a currently unrevealed account.

+ +
+
+
+
    +
  • +
    + + + + burnFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case burnFee
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allocationFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case allocationFee
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/OperationMetadata.html b/Structs/OperationMetadata.html new file mode 100644 index 00000000..abbc4167 --- /dev/null +++ b/Structs/OperationMetadata.html @@ -0,0 +1,946 @@ + + + + OperationMetadata Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationMetadata

+
+
+ +
public struct OperationMetadata : Codable
+ +
+
+

Structure representing the metadata needed by Operation‘s in order to comply with the RPC standards

+ +
+
+
+
    +
  • +
    + + + + managerKey + +
    +
    +
    +
    +
    +
    +

    The public key of the account managing the sender of this Operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let managerKey: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    +

    The current counter used by this account on the network. All future Operation‘s need to be 1 higher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let counter: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + chainID + +
    +
    +
    +
    +
    +
    +

    The current Tezos network chainID to use for Operation‘s

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let chainID: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + branch + +
    +
    +
    +
    +
    +
    +

    The current branch used by the head block, used for estiamting and running preapply, to ensure the latest state information is available

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let branch: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + protocol + +
    +
    +
    +
    +
    +
    +

    The current Tezos network protocol to use for Operation‘s

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let `protocol`: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationMetadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(managerKey: String?, counter: Int, blockchainHead: BlockchainHead)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + managerKey + + +
    +

    The public key of the account managing the sender of this Operation

    +
    +
    + + counter + + +
    +

    The current counter used by this account on the network. All future Operation‘s need to be 1 higher

    +
    +
    + + blockchainHead + + +
    +

    Decoded response of the blockchainHead, containing only the pieces we need

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/OperationPayload.html b/Structs/OperationPayload.html new file mode 100644 index 00000000..5b3b244a --- /dev/null +++ b/Structs/OperationPayload.html @@ -0,0 +1,918 @@ + + + + OperationPayload Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationPayload

+
+
+ +
public struct OperationPayload : Codable, Equatable
+ +
+
+

A structure representing the request that needs to be made when sending Opertion‘s to the RPC

+ +
+
+
+
    +
  • +
    + + + + branch + +
    +
    +
    +
    +
    +
    +

    The bracnh to use when sending

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var branch: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + contents + +
    +
    +
    +
    +
    +
    +

    An array of Operation‘s to be sent together in 1 request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var contents: [Operation]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: OperationPayload, rhs: OperationPayload) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Add the signature and the protocol to the operation so that it can be injected to the blockchain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func addSignature(_ binarySignature: [UInt8], signingCurve: EllipticalCurve)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + binarySignature + + +
    +

    Use the Wallet.sign(...) function to sign the forged version of the operationPayload.

    +
    +
    + + signingCurve + + +
    +

    The EllipticalCurve used for signing.

    +
    +
    + + andProtocol + + +
    +

    An OperationMetadata containing the network protocol to use to perform the injection.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func addProtcol(fromMetadata metadata: OperationMetadata)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/OperationResponse.html b/Structs/OperationResponse.html new file mode 100644 index 00000000..09b22fb8 --- /dev/null +++ b/Structs/OperationResponse.html @@ -0,0 +1,821 @@ + + + + OperationResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationResponse

+
+
+ +
public struct OperationResponse : Codable
+ +
+
+

Structure representing the response returned from RPC endpoints such as .../preapply/operations

+ +
+
+
+
    +
  • +
    + + + + contents + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contents: [OperationResponseContent]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFailed() + +
    +
    +
    +
    +
    +
    +

    Check if the operation(s) have been backtracked or reversed due to a failure

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isFailed() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors() + +
    +
    +
    +
    +
    +
    +

    Return the last error object from each internal result. The last error object is the one that contains the location of the error in the smart contract and the with string, giving the most debugable information

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func errors() -> [OperationResponseInternalResultError]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/OperationResponseInternalResultError.html b/Structs/OperationResponseInternalResultError.html new file mode 100644 index 00000000..c51603ee --- /dev/null +++ b/Structs/OperationResponseInternalResultError.html @@ -0,0 +1,923 @@ + + + + OperationResponseInternalResultError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationResponseInternalResultError

+
+
+ +
public struct OperationResponseInternalResultError : Codable, Equatable
+ +
+
+

Definition of the outer Error object found inside OperationResponseInternalResult

+ +
+
+
+
    +
  • +
    + + + + kind + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let kind: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + contract + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contract: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + expected + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let expected: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + found + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let found: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + location + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let location: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + with + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let with: FailWith?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/QuipuswapExchangeLedger.html b/Structs/QuipuswapExchangeLedger.html new file mode 100644 index 00000000..66267c7f --- /dev/null +++ b/Structs/QuipuswapExchangeLedger.html @@ -0,0 +1,795 @@ + + + + QuipuswapExchangeLedger Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeLedger

+
+
+ +
public struct QuipuswapExchangeLedger : Codable
+ +
+
+

The unique data inside the Ledger BigMap

+ +
+
+
+
    +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    Usable balance of the token owned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + frozen_balance + +
    +
    +
    +
    +
    +
    +

    Currently unaccessible balance of the token owned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let frozen_balance: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/QuipuswapExchangeLedgerKey.html b/Structs/QuipuswapExchangeLedgerKey.html new file mode 100644 index 00000000..b6286395 --- /dev/null +++ b/Structs/QuipuswapExchangeLedgerKey.html @@ -0,0 +1,767 @@ + + + + QuipuswapExchangeLedgerKey Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeLedgerKey

+
+
+ +
public struct QuipuswapExchangeLedgerKey : Codable
+ +
+
+

The gneric container object holding the raw data

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/QuipuswapExchangeStorage.html b/Structs/QuipuswapExchangeStorage.html new file mode 100644 index 00000000..403f1d77 --- /dev/null +++ b/Structs/QuipuswapExchangeStorage.html @@ -0,0 +1,1038 @@ + + + + QuipuswapExchangeStorage Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeStorage

+
+
+ +
public struct QuipuswapExchangeStorage : Codable
+ +
+
+

Unique Quipuswap contract storage object

+ +
+
+
+
    +
  • +
    + + + + ledger + +
    +
    +
    +
    +
    +
    +

    Ledger bigmap id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let ledger: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + user_rewards + +
    +
    +
    +
    +
    +
    +

    user rewards bigmap id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let user_rewards: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward + +
    +
    +
    +
    +
    +
    +

    The current reward

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward_paid + +
    +
    +
    +
    +
    +
    +

    The amount of rewards paid out

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward_paid: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + total_reward + +
    +
    +
    +
    +
    +
    +

    Total reward

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let total_reward: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + total_supply + +
    +
    +
    +
    +
    +
    +

    Totoal supply of this token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let total_supply: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + period_finish + +
    +
    +
    +
    +
    +
    +

    Date/Time the period will finish

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let period_finish: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward_per_sec + +
    +
    +
    +
    +
    +
    +

    The reward per second

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward_per_sec: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + last_update_time + +
    +
    +
    +
    +
    +
    +

    Date/Time of the last recorded update to the sotrage

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let last_update_time: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward_per_share + +
    +
    +
    +
    +
    +
    +

    The entitled reward per 1 share owned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward_per_share: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + date(from:) + +
    +
    +
    +
    +
    +
    +

    Convert a string to a Date object using Zulu time format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func date(from: String) -> Date?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/QuipuswapExchangeStorageResponse.html b/Structs/QuipuswapExchangeStorageResponse.html new file mode 100644 index 00000000..4f114204 --- /dev/null +++ b/Structs/QuipuswapExchangeStorageResponse.html @@ -0,0 +1,767 @@ + + + + QuipuswapExchangeStorageResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeStorageResponse

+
+
+ +
public struct QuipuswapExchangeStorageResponse : Codable
+ +
+
+

Network wrapper object

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/QuipuswapExchangeUserRewards.html b/Structs/QuipuswapExchangeUserRewards.html new file mode 100644 index 00000000..6add71d5 --- /dev/null +++ b/Structs/QuipuswapExchangeUserRewards.html @@ -0,0 +1,795 @@ + + + + QuipuswapExchangeUserRewards Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeUserRewards

+
+
+ +
public struct QuipuswapExchangeUserRewards : Codable
+ +
+
+

The unique data inside the User Rewards BigMap

+ +
+
+
+
    +
  • +
    + + + + reward + +
    +
    +
    +
    +
    +
    +

    Total reward the user has earned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward_paid + +
    +
    +
    +
    +
    +
    +

    Total rewards that have been paid out to the user

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward_paid: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/QuipuswapExchangeUserRewardsKey.html b/Structs/QuipuswapExchangeUserRewardsKey.html new file mode 100644 index 00000000..a044394b --- /dev/null +++ b/Structs/QuipuswapExchangeUserRewardsKey.html @@ -0,0 +1,767 @@ + + + + QuipuswapExchangeUserRewardsKey Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeUserRewardsKey

+
+
+ +
public struct QuipuswapExchangeUserRewardsKey : Codable
+ +
+
+

The gneric container object holding the raw data

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/RewardDetails.html b/Structs/RewardDetails.html new file mode 100644 index 00000000..30f86a91 --- /dev/null +++ b/Structs/RewardDetails.html @@ -0,0 +1,975 @@ + + + + RewardDetails Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

RewardDetails

+
+
+ +
public struct RewardDetails : Codable
+ +
+
+

An individual payment record denoting some payment in the past or future

+ +
+
+
+
    +
  • +
    + + + + bakerAlias + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bakerAlias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bakerLogo + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bakerLogo: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + paymentAddress + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let paymentAddress: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let amount: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + cycle + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cycle: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fee: Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + dateOfPayment + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let dateOfPayment: Date
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + meetsMinDelegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let meetsMinDelegation: Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(bakerAlias: String?, bakerLogo: URL?, paymentAddress: String, amount: XTZAmount, cycle: Int, fee: Double, date: Date, meetsMinDelegation: Bool)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/SVGImgProcessor.html b/Structs/SVGImgProcessor.html new file mode 100644 index 00000000..a19a7f71 --- /dev/null +++ b/Structs/SVGImgProcessor.html @@ -0,0 +1,793 @@ + + + + SVGImgProcessor Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

SVGImgProcessor

+
+
+ +
public struct SVGImgProcessor : ImageProcessor
+ +
+
+

SVG image processor for Kingfisher library

+ +
+
+
+
    +
  • +
    + + + + identifier + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var identifier: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/SubverifierWrapper.html b/Structs/SubverifierWrapper.html new file mode 100644 index 00000000..696c9bf9 --- /dev/null +++ b/Structs/SubverifierWrapper.html @@ -0,0 +1,849 @@ + + + + SubverifierWrapper Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

SubverifierWrapper

+
+
+ +
public struct SubverifierWrapper
+ +
+
+

SDK requires information about the verifer that can’t be stored inside the verifier, add a wrapper object to allow passing of all the data

+ +
+
+
+
    +
  • +
    + + + + aggregateVerifierName + +
    +
    +
    +
    +
    +
    +

    The name of the aggregated verifier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let aggregateVerifierName: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkType + +
    +
    +
    +
    +
    +
    +

    Unlike seed based wallets, Torus verifiers are bound to a network and generate different addresses. In order to give the same experience on Tezos, we need to supply the network for each verifier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let networkType: TezosNodeClientConfig.NetworkType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + subverifier + +
    +
    +
    +
    +
    +
    +

    The matching SubVerifierDetails object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let subverifier: SubVerifierDetails
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an instance of the object with an option string for the aggregate verifier name, and a SubVerifierDetails object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(aggregateVerifierName: String?, networkType: TezosNodeClientConfig.NetworkType, subverifier: SubVerifierDetails)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosDomainsAddressBulkResponse.html b/Structs/TezosDomainsAddressBulkResponse.html new file mode 100644 index 00000000..e1323998 --- /dev/null +++ b/Structs/TezosDomainsAddressBulkResponse.html @@ -0,0 +1,795 @@ + + + + TezosDomainsAddressBulkResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsAddressBulkResponse

+
+
+ +
public struct TezosDomainsAddressBulkResponse : Codable
+ +
+
+

Response object wrapper for querying an address in bulk

+ +
+
+
+
    +
  • +
    + + + + domains + +
    +
    +
    +
    +
    +
    +

    Object containing all the info of the record

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let domains: TezosDomainsDomains?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(domains:) + +
    +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(domains: TezosDomainsDomains?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosDomainsAddressResponse.html b/Structs/TezosDomainsAddressResponse.html new file mode 100644 index 00000000..0dbb4903 --- /dev/null +++ b/Structs/TezosDomainsAddressResponse.html @@ -0,0 +1,795 @@ + + + + TezosDomainsAddressResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsAddressResponse

+
+
+ +
public struct TezosDomainsAddressResponse : Codable
+ +
+
+

Response object wrapper for querying an address

+ +
+
+
+
    +
  • +
    + + + + domain + +
    +
    +
    +
    +
    +
    +

    Domain object containing details about the domain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let domain: TezosDomainsDomain
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(domain:) + +
    +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(domain: TezosDomainsDomain)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosDomainsDomain.html b/Structs/TezosDomainsDomain.html new file mode 100644 index 00000000..c9a03419 --- /dev/null +++ b/Structs/TezosDomainsDomain.html @@ -0,0 +1,822 @@ + + + + TezosDomainsDomain Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsDomain

+
+
+ +
public struct TezosDomainsDomain : Codable
+ +
+
+

Domain object containing details about the domain

+ +
+
+
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The domain name e.g. example.tez

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The Tezos address that the domain points too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(name:address:) + +
    +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(name: String, address: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosDomainsDomainBulkResponse.html b/Structs/TezosDomainsDomainBulkResponse.html new file mode 100644 index 00000000..ccf56c51 --- /dev/null +++ b/Structs/TezosDomainsDomainBulkResponse.html @@ -0,0 +1,795 @@ + + + + TezosDomainsDomainBulkResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsDomainBulkResponse

+
+
+ +
public struct TezosDomainsDomainBulkResponse : Codable
+ +
+
+

Response object wrapper for querying a reverse record in bulk

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/TezosDomainsDomainResponse.html b/Structs/TezosDomainsDomainResponse.html new file mode 100644 index 00000000..29258524 --- /dev/null +++ b/Structs/TezosDomainsDomainResponse.html @@ -0,0 +1,822 @@ + + + + TezosDomainsDomainResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsDomainResponse

+
+
+ +
public struct TezosDomainsDomainResponse : Codable
+ +
+
+

Response object wrapper for querying a reverse record

+ +
+
+
+
    +
  • +
    + + + + reverseRecord + +
    +
    +
    +
    +
    +
    +

    Object containing all the info of the record

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reverseRecord: TezosDomainsReverseRecord?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + domain() + +
    +
    +
    +
    +
    +
    +

    Helper to extract the domain name more easily

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func domain() -> String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(reverseRecord:) + +
    +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(reverseRecord: TezosDomainsReverseRecord?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosDomainsDomains.html b/Structs/TezosDomainsDomains.html new file mode 100644 index 00000000..43a31d81 --- /dev/null +++ b/Structs/TezosDomainsDomains.html @@ -0,0 +1,768 @@ + + + + TezosDomainsDomains Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsDomains

+
+
+ +
public struct TezosDomainsDomains : Codable
+ +
+
+

Object containing an array of domains

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/TezosDomainsReverseRecord.html b/Structs/TezosDomainsReverseRecord.html new file mode 100644 index 00000000..b45d885d --- /dev/null +++ b/Structs/TezosDomainsReverseRecord.html @@ -0,0 +1,903 @@ + + + + TezosDomainsReverseRecord Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsReverseRecord

+
+
+ +
public struct TezosDomainsReverseRecord : Codable
+ +
+
+

Object containing all the info of the tezos domains record

+ +
+
+
+
    +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    +

    Uniquie id of the domain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The address that the domain points too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + owner + +
    +
    +
    +
    +
    +
    +

    The address that owns the domain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let owner: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + expiresAtUtc + +
    +
    +
    +
    +
    +
    +

    Expiration date

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let expiresAtUtc: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + domain + +
    +
    +
    +
    +
    +
    +

    The domain object continaing the name and address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let domain: TezosDomainsDomain
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(id: String, address: String, owner: String, expiresAtUtc: String?, domain: TezosDomainsDomain)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosDomainsReverseRecords.html b/Structs/TezosDomainsReverseRecords.html new file mode 100644 index 00000000..49c07ae0 --- /dev/null +++ b/Structs/TezosDomainsReverseRecords.html @@ -0,0 +1,768 @@ + + + + TezosDomainsReverseRecords Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsReverseRecords

+
+
+ +
public struct TezosDomainsReverseRecords : Codable
+ +
+
+

Object containing an array of reverse records

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/TezosNodeClientConfig.html b/Structs/TezosNodeClientConfig.html new file mode 100644 index 00000000..423d6323 --- /dev/null +++ b/Structs/TezosNodeClientConfig.html @@ -0,0 +1,1417 @@ + + + + TezosNodeClientConfig Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosNodeClientConfig

+
+
+ +
public struct TezosNodeClientConfig
+ +
+
+

A configuration object used to provide settings to the TezosNodeClient

+ +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + NetworkType + +
    +
    +
    +
    +
    +
    +

    An enum indicating whether the network is mainnet or testnet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum NetworkType : String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ForgingType + +
    +
    +
    +
    +
    +
    +

    Allow switching between local forging or remote forging+parsing

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum ForgingType : String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Constants +

+
+
+
    +
  • +
    + + + + defaultMainnetURLs + +
    +
    +
    +
    +
    +
    +

    Preconfigured struct with all the URL’s needed to work with Tezos mainnet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct defaultMainnetURLs
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + defaultTestnetURLs + +
    +
    +
    +
    +
    +
    +

    Preconfigured struct with all the URL’s needed to work with Tezos testnet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct defaultTestnetURLs
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + primaryNodeURL + +
    +
    +
    +
    +
    +
    +

    The main URL used for remote forging, fetching balances, setting delegates and other forms of queries and operations.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let primaryNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseNodeURL + +
    +
    +
    +
    +
    +
    +

    When using remote forging, it is essential to use a second server to verify the contents of the remote forge match what the library sent.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parseNodeURL: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + forgingType + +
    +
    +
    +
    +
    +
    +

    Controls whether to use local forging or remote forging+parsing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let forgingType: ForgingType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzktURL + +
    +
    +
    +
    +
    +
    +

    The URL to use for TzKTClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tzktURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + betterCallDevURL + +
    +
    +
    +
    +
    +
    +

    The URL to use for BetterCallDevClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let betterCallDevURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tezosDomainsURL + +
    +
    +
    +
    +
    +
    +

    The URL to use for TezosDomainsClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tezosDomainsURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + objktApiURL + +
    +
    +
    +
    +
    +
    +

    The URL to use for TezosDomainsClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let objktApiURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + urlSession + +
    +
    +
    +
    +
    +
    +

    The URLSession that will be used for all network communication. If looking to mock this library, users should create their own URLSessionMock and pass it in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var urlSession: URLSession
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkType + +
    +
    +
    +
    +
    +
    +

    The network type of the connected node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let networkType: NetworkType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + loggingConfig + +
    +
    +
    +
    +
    +
    +

    Control what gets logged to the console

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var loggingConfig: LoggingConfig
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Init a TezosNodeClientConfig with the defaults

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(withDefaultsForNetworkType networkType: NetworkType)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + withDefaultsForNetworkType + + +
    +

    Use the default settings for the given network type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an instance of TezosNodeClientConfig with only the required properties needed when using local forge.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func configWithLocalForge(primaryNodeURL: URL, tzktURL: URL, betterCallDevURL: URL, tezosDomainsURL: URL, objktApiURL: URL, urlSession: URLSession, networkType: NetworkType) -> TezosNodeClientConfig
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + primaryNodeURL + + +
    +

    The URL of the primary node that will perform the majority of the network operations.

    +
    +
    + + tzktURL + + +
    +

    The URL to use for TzKTClient.

    +
    +
    + + betterCallDevURL + + +
    +

    The URL to use for BetterCallDevClient.

    +
    +
    + + urlSession + + +
    +

    The URLSession object that will perform all the network operations.

    +
    +
    + + networkType + + +
    +

    Enum indicating the network type.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an instance of TezosNodeClientConfig with the required properties for remote forging. Note: function will casue a fatalError is users attempt to set primaryNodeURL and parseNodeURL to the same destination

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func configWithRemoteForge(primaryNodeURL: URL, parseNodeURL: URL, tzktURL: URL, betterCallDevURL: URL, tezosDomainsURL: URL, objktApiURL: URL, urlSession: URLSession, networkType: NetworkType) -> TezosNodeClientConfig
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + primaryNodeURL + + +
    +

    The URL of the primary node that will perform the majority of the network operations.

    +
    +
    + + parseNodeURL + + +
    +

    The URL to use to parse and verify a remote forge. Must be a different server to primary node.

    +
    +
    + + tzktURL + + +
    +

    The URL to use for TzKTClient.

    +
    +
    + + betterCallDevURL + + +
    +

    The URL to use for BetterCallDevClient.

    +
    +
    + + urlSession + + +
    +

    The URLSession object that will perform all the network operations.

    +
    +
    + + networkType + + +
    +

    Enum indicating the network type.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosNodeClientConfig/ForgingType.html b/Structs/TezosNodeClientConfig/ForgingType.html new file mode 100644 index 00000000..9fce5776 --- /dev/null +++ b/Structs/TezosNodeClientConfig/ForgingType.html @@ -0,0 +1,793 @@ + + + + ForgingType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ForgingType

+
+
+ +
public enum ForgingType : String
+ +
+
+

Allow switching between local forging or remote forging+parsing

+ +
+
+
+
    +
  • +
    + + + + local + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case local
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + remote + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case remote
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosNodeClientConfig/NetworkType.html b/Structs/TezosNodeClientConfig/NetworkType.html new file mode 100644 index 00000000..cd6cbb38 --- /dev/null +++ b/Structs/TezosNodeClientConfig/NetworkType.html @@ -0,0 +1,793 @@ + + + + NetworkType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkType

+
+
+ +
public enum NetworkType : String
+ +
+
+

An enum indicating whether the network is mainnet or testnet

+ +
+
+
+
    +
  • +
    + + + + mainnet + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case mainnet
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + testnet + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case testnet
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosNodeClientConfig/defaultMainnetURLs.html b/Structs/TezosNodeClientConfig/defaultMainnetURLs.html new file mode 100644 index 00000000..341c9610 --- /dev/null +++ b/Structs/TezosNodeClientConfig/defaultMainnetURLs.html @@ -0,0 +1,903 @@ + + + + defaultMainnetURLs Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

defaultMainnetURLs

+
+
+ +
public struct defaultMainnetURLs
+ +
+
+

Preconfigured struct with all the URL’s needed to work with Tezos mainnet

+ +
+
+
+
    +
  • +
    + + + + primaryNodeURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for primaryNodeURL, For more information on the free service, see: https://tezos.giganode.io/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let primaryNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseNodeURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for parseNodeURL, For more information on the free service, see: https://nautilus.cloud/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let parseNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzktURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tzktURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + betterCallDevURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let betterCallDevURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tezosDomainsURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tezosDomainsURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + objktApiURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let objktApiURL: URL
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TezosNodeClientConfig/defaultTestnetURLs.html b/Structs/TezosNodeClientConfig/defaultTestnetURLs.html new file mode 100644 index 00000000..1617410b --- /dev/null +++ b/Structs/TezosNodeClientConfig/defaultTestnetURLs.html @@ -0,0 +1,904 @@ + + + + defaultTestnetURLs Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

defaultTestnetURLs

+
+
+ +
public struct defaultTestnetURLs
+ +
+
+

Preconfigured struct with all the URL’s needed to work with Tezos testnet

+ +
+
+
+
    +
  • +
    + + + + primaryNodeURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for primaryNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let primaryNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseNodeURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for parseNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about +When using remote forging on mainnet, you should use two seperate servers on seperate networks for security reasons

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let parseNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzktURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tzktURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + betterCallDevURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let betterCallDevURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tezosDomainsURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tezosDomainsURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + objktApiURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let objktApiURL: URL
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTAccount.html b/Structs/TzKTAccount.html new file mode 100644 index 00000000..aa817f84 --- /dev/null +++ b/Structs/TzKTAccount.html @@ -0,0 +1,1036 @@ + + + + TzKTAccount Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTAccount

+
+
+ +
public struct TzKTAccount : Codable, Equatable
+ +
+
+

Model mapping to TzKT.io’s Account object

+ +
+
+
+
    +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    The address XTZ balance in RPC format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    type of account e.g. “user” or “empty”

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    tz1/2/3 kt1 address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    +

    prefixed public key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let publicKey: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + revealed + +
    +
    +
    +
    +
    +
    +

    whether or not the account has performed a reveal operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let revealed: Bool?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    The addresses delegation status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegate: TzKTAccountDelegate?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegationLevel + +
    +
    +
    +
    +
    +
    +

    The block level the delegate address was set

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegationLevel: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + activeTokensCount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let activeTokensCount: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenBalancesCount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenBalancesCount: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtzBalance + +
    +
    +
    +
    +
    +
    +

    Helper method to convert the RPC balance into an XTZAmount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var xtzBalance: XTZAmount { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Generic init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(balance: Decimal?, type: String, address: String, publicKey: String, revealed: Bool, delegate: TzKTAccountDelegate?, delegationLevel: Decimal?, activeTokensCount: Decimal?, tokenBalancesCount: Decimal?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTAccountDelegate.html b/Structs/TzKTAccountDelegate.html new file mode 100644 index 00000000..7e1273fe --- /dev/null +++ b/Structs/TzKTAccountDelegate.html @@ -0,0 +1,848 @@ + + + + TzKTAccountDelegate Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTAccountDelegate

+
+
+ +
public struct TzKTAccountDelegate : Codable, Equatable
+ +
+
+

Model mapping to TzKT.io’s Account.Delegate Object

+ +
+
+
+
    +
  • +
    + + + + alias + +
    +
    +
    +
    +
    +
    +

    Bakers may have an alias (human readbale) name for their service

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let alias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    Bakers must have a valid address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + active + +
    +
    +
    +
    +
    +
    +

    Bool indicating whether or not the baker is currently active

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let active: Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(alias: String?, address: String, active: Bool)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTAddress.html b/Structs/TzKTAddress.html new file mode 100644 index 00000000..157568d1 --- /dev/null +++ b/Structs/TzKTAddress.html @@ -0,0 +1,821 @@ + + + + TzKTAddress Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTAddress

+
+
+ +
public struct TzKTAddress : Codable
+ +
+
+

Details about a given contract

+ +
+
+
+
    +
  • +
    + + + + alias + +
    +
    +
    +
    +
    +
    +

    Contract addresses may have an alias (human readbale) name, to denote a person or service

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let alias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The KT1 address of the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(alias:address:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(alias: String?, address: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBaker.html b/Structs/TzKTBaker.html new file mode 100644 index 00000000..f25313c5 --- /dev/null +++ b/Structs/TzKTBaker.html @@ -0,0 +1,1369 @@ + + + + TzKTBaker Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBaker

+
+
+ +
public struct TzKTBaker : Codable, Hashable
+ +
+
+

Data representing a baker from TzKT or Baking-Bad

+ +
+
+
+
    +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + logo + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let logo: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + stakingBalance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let stakingBalance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + stakingCapacity + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let stakingCapacity: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + maxStakingBalance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let maxStakingBalance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + freeSpace + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let freeSpace: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fee: Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + minDelegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let minDelegation: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutDelay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutDelay: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutPeriod + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutPeriod: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + openForDelegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let openForDelegation: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + estimatedRoi + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let estimatedRoi: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + serviceHealth + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let serviceHealth: TzKTBakerHealth
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutTiming + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutTiming: TzKTBakerTiming
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutAccuracy + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutAccuracy: TzKTBakerAccuracy
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + config + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let config: TzKTBakerConfig?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper to create a TzKTBaker from the data available from the Account object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(address: String, name: String?, logo: String?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(address: String, name: String?, logo: String?, balance: Decimal, stakingBalance: Decimal, stakingCapacity: Decimal, maxStakingBalance: Decimal, freeSpace: Decimal, fee: Double, minDelegation: Decimal, payoutDelay: Int, payoutPeriod: Int, openForDelegation: Bool, estimatedRoi: Decimal, serviceHealth: TzKTBakerHealth, payoutTiming: TzKTBakerTiming, payoutAccuracy: TzKTBakerAccuracy, config: TzKTBakerConfig?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fromTestnetArray(_:) + +
    +
    +
    +
    +
    +
    +

    Ghostnet has a different setup for bakers, but we need to display and interact with them the same way. +So this helper extract what it can from the API and creates semi-real baker objects to help users deal with Ghostnet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func fromTestnetArray(_ data: [Any]) -> TzKTBaker?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + rewardStruct() + +
    +
    +
    +
    +
    +
    +

    Convert con-chain data into a meaningful, readable object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func rewardStruct() -> TzKTBakerConfigRewardStruct?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: TzKTBaker, rhs: TzKTBaker) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBakerConfig.html b/Structs/TzKTBakerConfig.html new file mode 100644 index 00000000..92ba61ae --- /dev/null +++ b/Structs/TzKTBakerConfig.html @@ -0,0 +1,1001 @@ + + + + TzKTBakerConfig Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerConfig

+
+
+ +
public struct TzKTBakerConfig : Codable
+ +
+
+

The bakers config file for details on when fees, min delegation etc change

+ +
+
+
+
    +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fee: [TzKTBakerConfigDoubleValue]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + minDelegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let minDelegation: [TzKTBakerConfigDoubleValue]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutDelay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutDelay: [TzKTBakerConfigIntValue]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + rewardStruct + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let rewardStruct: [TzKTBakerConfigIntValue]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + latesetFee() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func latesetFee() -> Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + feeForCycle(cycle:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func feeForCycle(cycle: Int) -> Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + latestPayoutDelay() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func latestPayoutDelay() -> Int
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func payoutDelayForCycle(cycle: Int) -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + latestRewardStruct() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func latestRewardStruct() -> Int?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBakerConfigDoubleValue.html b/Structs/TzKTBakerConfigDoubleValue.html new file mode 100644 index 00000000..741e7cae --- /dev/null +++ b/Structs/TzKTBakerConfigDoubleValue.html @@ -0,0 +1,792 @@ + + + + TzKTBakerConfigDoubleValue Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerConfigDoubleValue

+
+
+ +
public struct TzKTBakerConfigDoubleValue : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + cycle + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cycle: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: Double
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBakerConfigIntValue.html b/Structs/TzKTBakerConfigIntValue.html new file mode 100644 index 00000000..b9e45585 --- /dev/null +++ b/Structs/TzKTBakerConfigIntValue.html @@ -0,0 +1,792 @@ + + + + TzKTBakerConfigIntValue Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerConfigIntValue

+
+
+ +
public struct TzKTBakerConfigIntValue : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + cycle + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cycle: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBakerConfigRewardStruct.html b/Structs/TzKTBakerConfigRewardStruct.html new file mode 100644 index 00000000..ad1f2758 --- /dev/null +++ b/Structs/TzKTBakerConfigRewardStruct.html @@ -0,0 +1,1028 @@ + + + + TzKTBakerConfigRewardStruct Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerConfigRewardStruct

+
+
+ +
public struct TzKTBakerConfigRewardStruct : Codable
+ +
+
+

Baker config payout flags

+ +
+
+
+
    +
  • +
    + + + + blocks + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let blocks: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedBlocks + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedBlocks: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endorsements + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let endorsements: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedEndorsements + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedEndorsements: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fees + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fees: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedFees + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedFees: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + accusationRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let accusationRewards: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + accusationLosses + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let accusationLosses: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + revelationRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let revelationRewards: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + revelationLosses + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let revelationLosses: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fromConfigInt(_:) + +
    +
    +
    +
    +
    +
    +

    Convert the 14-bit number in the baker config, to the equivalent set of flags

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func fromConfigInt(_ config: Int) -> TzKTBakerConfigRewardStruct
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBalance.html b/Structs/TzKTBalance.html new file mode 100644 index 00000000..79d505ea --- /dev/null +++ b/Structs/TzKTBalance.html @@ -0,0 +1,901 @@ + + + + TzKTBalance Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalance

+
+
+ +
public struct TzKTBalance : Codable
+ +
+
+

Model mapping to the Balance object returned from the new TzKT API, resulting from the merge of BCD and TzKT

+ +
+
+
+
    +
  • +
    + + + + exceptionListNFT + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let exceptionListNFT: [String]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    String containing the RPC respresetnation of the balance of the given token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    Details about the Token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token: TzKTBalanceToken
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenAmount + +
    +
    +
    +
    +
    +
    +

    Helper to convert the RPC token balance to a TokenAmount object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tokenAmount: TokenAmount { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isNFT() + +
    +
    +
    +
    +
    +
    +

    Basic check to see if token is an NFT or not. May not be 100% successful, needs research

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isNFT() -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isOnNFTExceptionList() -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBalanceMetadata.html b/Structs/TzKTBalanceMetadata.html new file mode 100644 index 00000000..890c269f --- /dev/null +++ b/Structs/TzKTBalanceMetadata.html @@ -0,0 +1,1308 @@ + + + + TzKTBalanceMetadata Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceMetadata

+
+
+ +
public struct TzKTBalanceMetadata : Codable
+ +
+
+

Metadata object for the token

+ +
+
+
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    A human readbale name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    +

    The tokens symbol

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var symbol: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimals + +
    +
    +
    +
    +
    +
    +

    The number of decimals the token has

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimals: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimalsInt + +
    +
    +
    +
    +
    +
    +

    Helper to convert the decimals to an Int

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimalsInt: Int { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + formats + +
    +
    +
    +
    +
    +
    +

    Details of the available formats that the media is available in

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var formats: [TzKTBalanceMetadataFormat]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + displayUri + +
    +
    +
    +
    +
    +
    +

    URI to an medium/large image owned by the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var displayUri: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + artifactUri + +
    +
    +
    +
    +
    +
    +

    URI to the raw media artifact owned by the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var artifactUri: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + thumbnailUri + +
    +
    +
    +
    +
    +
    +

    URI to an small image for the token, ususally used as an icon when displayed in lists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var thumbnailUri: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Description of the token or NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mintingTool + +
    +
    +
    +
    +
    +
    +

    URL to the tool that was used to mint the item

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var mintingTool: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tags + +
    +
    +
    +
    +
    +
    +

    A list of tags to categorize the token / NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tags: [String]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + minter + +
    +
    +
    +
    +
    +
    +

    The address responsible for creating the token / NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var minter: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shouldPreferSymbol + +
    +
    +
    +
    +
    +
    +

    Whether or not the symbol or the name is prefered when displaying the token / NFT in a list

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var shouldPreferSymbol: Bool?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + attributes + +
    +
    +
    +
    +
    +
    +

    A collection of attributes about the token/NFT. Although TZIP-16 intended for this to be filled with info such as license, version, possible error messages etc, +It has been adopted by NFT creators as a more free-form dictionary. An example would be for gaming NFT’s, this might be a list of attack/defensive moves the character is able to use +It is extremely likely that the actual type will be [[String: String]], however due to various issues and complexities of using a strongly typed language like Swift, +the easiest solution was to use [Any] with a custom decoder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var attributes: [Any]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ttl + +
    +
    +
    +
    +
    +
    +

    Flag, in seconds, indicating how long to wait before refreshing the token to update its metadata. E.g. fxHash will inject a token with a name “[Waiting to be Signed]”. and then, all things going well, 30 seconds later its updated to the correct attributes

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let ttl: Int?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(name: String?, symbol: String?, decimals: String, formats: [TzKTBalanceMetadataFormat]?, displayUri: String?, artifactUri: String?, thumbnailUri: String?, description: String?, mintingTool: String?, tags: [String]?, minter: String?, shouldPreferSymbol: Bool?, attributes: [Any]?, ttl: Int?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + thumbnailURL + +
    +
    +
    +
    +
    +
    +

    Helper to run the URI through the MediaProxyService to generate a useable URL for the thumbnail (if available)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var thumbnailURL: URL? { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + displayURL + +
    +
    +
    +
    +
    +
    +

    Helper to run the URI through the MediaProxyService to generate a useable URL for the display image (if available)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var displayURL: URL? { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Attributes is a complex free-form object. In a lot of cases when NFT’s are games / collectibles, it should be possible to convert most if not all the elements into more simple String: String key value pairs, which will be easier to manage in table / collection views

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getKeyValuesFromAttributes() -> [TzKTBalanceMetadataAttributeKeyValue]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBalanceMetadataAttributeKeyValue.html b/Structs/TzKTBalanceMetadataAttributeKeyValue.html new file mode 100644 index 00000000..9aa8c9d9 --- /dev/null +++ b/Structs/TzKTBalanceMetadataAttributeKeyValue.html @@ -0,0 +1,819 @@ + + + + TzKTBalanceMetadataAttributeKeyValue Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceMetadataAttributeKeyValue

+
+
+ +
public struct TzKTBalanceMetadataAttributeKeyValue : Codable, Hashable
+ +
+
+

Wrapper / Helper to extract metadata attribute content

+ +
+
+
+
    +
  • +
    + + + + key + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let key: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(key:value:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(key: String, value: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBalanceMetadataDimensions.html b/Structs/TzKTBalanceMetadataDimensions.html new file mode 100644 index 00000000..39db578e --- /dev/null +++ b/Structs/TzKTBalanceMetadataDimensions.html @@ -0,0 +1,822 @@ + + + + TzKTBalanceMetadataDimensions Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceMetadataDimensions

+
+
+ +
public struct TzKTBalanceMetadataDimensions : Codable
+ +
+
+

Object containing information about the dimensions of a given piece of media

+ +
+
+
+
    +
  • +
    + + + + unit + +
    +
    +
    +
    +
    +
    +

    The unit of measurement (e.g. px for pixels)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let unit: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    String containing the resolution or size (e.g. 1024x787)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(unit:value:) + +
    +
    +
    +
    +
    +
    +

    Init to manaually create an instance, mostly for testing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(unit: String, value: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBalanceMetadataFormat.html b/Structs/TzKTBalanceMetadataFormat.html new file mode 100644 index 00000000..d57a9e27 --- /dev/null +++ b/Structs/TzKTBalanceMetadataFormat.html @@ -0,0 +1,849 @@ + + + + TzKTBalanceMetadataFormat Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceMetadataFormat

+
+
+ +
public struct TzKTBalanceMetadataFormat : Codable
+ +
+
+

Object containing information about the various formats the media is available in

+ +
+
+
+
    +
  • +
    + + + + uri + +
    +
    +
    +
    +
    +
    +

    The URI to this specific format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let uri: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mimeType + +
    +
    +
    +
    +
    +
    +

    The mimetype of this version

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let mimeType: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + dimensions + +
    +
    +
    +
    +
    +
    +

    The display dimensions

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let dimensions: TzKTBalanceMetadataDimensions?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init to manaually create an instance, mostly for testing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(uri: String, mimeType: String, dimensions: TzKTBalanceMetadataDimensions?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTBalanceToken.html b/Structs/TzKTBalanceToken.html new file mode 100644 index 00000000..ccbdffc3 --- /dev/null +++ b/Structs/TzKTBalanceToken.html @@ -0,0 +1,1007 @@ + + + + TzKTBalanceToken Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceToken

+
+
+ +
public struct TzKTBalanceToken : Codable
+ +
+
+

Model encapsulating information about the token itself

+ +
+
+
+
    +
  • +
    + + + + contract + +
    +
    +
    +
    +
    +
    +

    Details of the contract (e.g. address)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contract: TzKTAddress
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    +

    The FA2 token ID of the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenId: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + standard + +
    +
    +
    +
    +
    +
    +

    Which FA version the token conforms too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let standard: FaVersion
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + totalSupply + +
    +
    +
    +
    +
    +
    +

    Total avaialble supply of this address + token id combo

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let totalSupply: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Metadata about the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var metadata: TzKTBalanceMetadata?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + malformedMetadata + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var malformedMetadata: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + displaySymbol + +
    +
    +
    +
    +
    +
    +

    Helper to determine what string is used as the symbol for display purposes

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var displaySymbol: String { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(contract: TzKTAddress, tokenId: String, standard: FaVersion, totalSupply: String?, metadata: TzKTBalanceMetadata?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTCycle.html b/Structs/TzKTCycle.html new file mode 100644 index 00000000..5e7e7c0b --- /dev/null +++ b/Structs/TzKTCycle.html @@ -0,0 +1,923 @@ + + + + TzKTCycle Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTCycle

+
+
+ +
public struct TzKTCycle : Codable
+ +
+
+

The blockchain is broken down into cycles that last 2.7 days. Baker payment logic resolves around cycles instead of blocks

+ +
+
+
+
    +
  • +
    + + + + index + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let index: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + startTime + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let startTime: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + firstLevel + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let firstLevel: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endTime + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let endTime: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lastLevel + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let lastLevel: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + stateDate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var stateDate: Date? { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endDate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var endDate: Date? { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTDelegatorReward.html b/Structs/TzKTDelegatorReward.html new file mode 100644 index 00000000..15e37cf6 --- /dev/null +++ b/Structs/TzKTDelegatorReward.html @@ -0,0 +1,1132 @@ + + + + TzKTDelegatorReward Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTDelegatorReward

+
+
+ +
public struct TzKTDelegatorReward : Codable
+ +
+
+

An object containing info on the reward a delegator should receive from a baker

+ +
+
+
+
    +
  • +
    + + + + cycle + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cycle: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + baker + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let baker: TzKTAddress
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + stakingBalance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let stakingBalance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + blockRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let blockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedBlockRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedBlockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endorsementRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let endorsementRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedEndorsementRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + blockFees + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let blockFees: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedBlockFees + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedBlockFees: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + extraBlockRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let extraBlockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedExtraBlockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + futureBlockRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let futureBlockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let futureEndorsementRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return an estimated either for potential future or actual rewards

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func estimatedReward(withFee fee: Double, andRewardStruct: TzKTBakerConfigRewardStruct?) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTOperation.html b/Structs/TzKTOperation.html new file mode 100644 index 00000000..4a33ee57 --- /dev/null +++ b/Structs/TzKTOperation.html @@ -0,0 +1,1038 @@ + + + + TzKTOperation Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTOperation

+
+
+ +
public struct TzKTOperation : Codable
+ +
+
+

A model matching the response that comes back from TzKT’s API: v1/operations/<operation-hash>

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    Type of operation (e.g. transaction, delegation, reveal etc)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    +

    Unique id to denote the operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    +

    The block level it was injected at

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    +

    Timestamp it was injected at

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + block + +
    +
    +
    +
    +
    +
    +

    The hash of the injected block

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let block: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    +

    The operation hash

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    +

    The users numerical counter of the operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let counter: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    Status of the operation (e.g. applied or failed)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let status: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    +

    Optional array of errors encountered while trying to inject the operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errors: [TzKTOperationError]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFailed() + +
    +
    +
    +
    +
    +
    +

    Helper to detect a failed transation by searching for a status of “failed”, “backtracked” or “skipped”

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isFailed() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + containsError() + +
    +
    +
    +
    +
    +
    +

    Helper to detect if this operation contains an error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func containsError() -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTOperationError.html b/Structs/TzKTOperationError.html new file mode 100644 index 00000000..49e172fe --- /dev/null +++ b/Structs/TzKTOperationError.html @@ -0,0 +1,768 @@ + + + + TzKTOperationError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTOperationError

+
+
+ +
public struct TzKTOperationError : Codable
+ +
+
+

TzKT’s more basic error object response

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The RPC error type string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTTokenTransfer.html b/Structs/TzKTTokenTransfer.html new file mode 100644 index 00000000..0ba9ff99 --- /dev/null +++ b/Structs/TzKTTokenTransfer.html @@ -0,0 +1,1027 @@ + + + + TzKTTokenTransfer Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTTokenTransfer

+
+
+ +
public struct TzKTTokenTransfer : Codable
+ +
+
+

FA1.2 / FA2 token transafers are treated differently from transactions. This object is used when fetching data form the API, as a temporary placeholder, ultimately to be merged into the transactions

+ +
+
+
+
    +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var hash: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token: TzKTBalanceToken
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + to + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let to: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + from + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let from: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let amount: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + transactionId + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let transactionId: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mintingTool + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let mintingTool: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenAmount() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenAmount() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTTransaction.html b/Structs/TzKTTransaction.html new file mode 100644 index 00000000..3a862654 --- /dev/null +++ b/Structs/TzKTTransaction.html @@ -0,0 +1,2131 @@ + + + + TzKTTransaction Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTTransaction

+
+
+ +
public struct TzKTTransaction : Codable, CustomStringConvertible, Hashable, Identifiable
+ +
+
+

A model matching the response that comes back from TzKT’s API: v1/accounts/<address>/operations

+ +
+
+
+
    +
  • +
    + + + + dateFormatter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let dateFormatter: DateFormatter
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + TransactionStatus + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TransactionStatus : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TransactionType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TransactionType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TransactionSubType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TransactionSubType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TransactionError + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TransactionError : Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: TransactionType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let counter: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + initiater + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let initiater: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + sender + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let sender: TzKTAddress
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bakerFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var bakerFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + storageFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var storageFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allocationFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var allocationFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + target + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var target: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + prevDelegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let prevDelegate: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + newDelegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let newDelegate: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var amount: TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parameter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parameter: [String : String]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let status: TransactionStatus
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hasInternals + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hasInternals: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenTransfersCount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenTransfersCount: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errors: [TransactionError]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + date + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let date: Date?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzktTokenTransfer + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tzktTokenTransfer: TzKTTokenTransfer? { get set }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + subType + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var subType: TransactionSubType?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + entrypointCalled + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var entrypointCalled: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + primaryToken + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var primaryToken: Token?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

CustomStringConvertible +

+
+
+
    +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Hashable +

+
+
+
    +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: TzKTTransaction, rhs: TzKTTransaction) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable Protocol +

+
+
+ +
+
+
+ + +
+ +

Helpers +

+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parameterValueAsArray() -> [Any]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parameterValueAsDict() -> [String : Any]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parameterValueAsArrayOfDictionary() -> [[String : Any]]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parameterValueAsType<T>(type: T.Type) -> T?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + getEntrypoint() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getEntrypoint() -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func processAdditionalData(withCurrentWalletAddress currentWalletAddress: String)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + createPrimaryToken() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func createPrimaryToken() -> Token?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The TzKT transaction API doesn’t provide all the info needed to normalise Token amounts. It only gives address and rpc amount. +Burried inside the michelson, the dex contract needs to be told the token id, and the target will contain the address. +This function will try to extract address, token id and rpc amount and return them in the standard objects, so that they can be used in conjuction with other functions to fetch the decimal data. +e.g. DipDup client can fetch all tokens from dexes, containing all token info. Using the address and id, the rest could be found via that, assuming zero for anything else (such as NFTs)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getFaTokenTransferData() -> Token?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getTokenTransferDestination() -> String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errorString() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func errorString() -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTTransaction/CodingKeys.html b/Structs/TzKTTransaction/CodingKeys.html new file mode 100644 index 00000000..c5d0722c --- /dev/null +++ b/Structs/TzKTTransaction/CodingKeys.html @@ -0,0 +1,1338 @@ + + + + CodingKeys Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

CodingKeys

+
+
+ +
public enum CodingKeys : String, CodingKey
+ +
+
+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case type
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case id
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case level
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case timestamp
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case hash
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case counter
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + initiater + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case initiater
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + sender + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case sender
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bakerFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case bakerFee
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + storageFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case storageFee
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allocationFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case allocationFee
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + target + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case target
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + prevDelegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case prevDelegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + newDelegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case newDelegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case amount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parameter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parameter
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case status
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + subType + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case subType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + entrypointCalled + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case entrypointCalled
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + primaryToken + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case primaryToken
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hasInternals + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case hasInternals
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenTransfersCount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case tokenTransfersCount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case errors
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTTransaction/TransactionStatus.html b/Structs/TzKTTransaction/TransactionStatus.html new file mode 100644 index 00000000..0f41684b --- /dev/null +++ b/Structs/TzKTTransaction/TransactionStatus.html @@ -0,0 +1,922 @@ + + + + TransactionStatus Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TransactionStatus

+
+
+ +
public enum TransactionStatus : String, Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + applied + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case applied
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + failed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case failed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + backtracked + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case backtracked
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unconfirmed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unconfirmed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + partiallyConfirmed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case partiallyConfirmed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + confirmed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case confirmed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTTransaction/TransactionSubType.html b/Structs/TzKTTransaction/TransactionSubType.html new file mode 100644 index 00000000..e36abed1 --- /dev/null +++ b/Structs/TzKTTransaction/TransactionSubType.html @@ -0,0 +1,922 @@ + + + + TransactionSubType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TransactionSubType

+
+
+ +
public enum TransactionSubType : String, Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + send + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case send
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + receive + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case receive
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case delegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reveal + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case reveal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchange + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case exchange
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + contractCall + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case contractCall
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTTransaction/TransactionType.html b/Structs/TzKTTransaction/TransactionType.html new file mode 100644 index 00000000..8cda660f --- /dev/null +++ b/Structs/TzKTTransaction/TransactionType.html @@ -0,0 +1,870 @@ + + + + TransactionType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TransactionType

+
+
+ +
public enum TransactionType : String, Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + delegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case delegation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + origination + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case origination
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + transaction + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case transaction
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reveal + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case reveal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/TzKTTransactionGroup.html b/Structs/TzKTTransactionGroup.html new file mode 100644 index 00000000..29cb18f5 --- /dev/null +++ b/Structs/TzKTTransactionGroup.html @@ -0,0 +1,1089 @@ + + + + TzKTTransactionGroup Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTTransactionGroup

+
+
+ +
public struct TzKTTransactionGroup : Codable, Hashable, Identifiable, CustomStringConvertible
+ +
+
+

Artifical object used to group related transactions into a more user friendly display +For example, 1 contract call can reuslt in many transactions being returned. To avoid the users UI being clogged, we group all them into 1 group, so the user only needs to see 1 item for 1 action they performed

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + groupType + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var groupType: TzKTTransaction.TransactionSubType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + transactions + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let transactions: [TzKTTransaction]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let status: TzKTTransaction.TransactionStatus
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + primaryToken + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var primaryToken: Token?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + secondaryToken + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var secondaryToken: Token?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + entrypointCalled + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var entrypointCalled: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var id: Decimal { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(withTransactions transactions: [TzKTTransaction], currentWalletAddress: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

CustomStringConvertible +

+
+
+
    +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Hashable +

+
+
+
    +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: TzKTTransactionGroup, rhs: TzKTTransactionGroup) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/Structs/WalletMetadata.html b/Structs/WalletMetadata.html new file mode 100644 index 00000000..f1b69982 --- /dev/null +++ b/Structs/WalletMetadata.html @@ -0,0 +1,1313 @@ + + + + WalletMetadata Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletMetadata

+
+
+ +
public struct WalletMetadata : Codable, Hashable
+ +
+
+

Object to store UI related info about wallets, seperated from the wallet object itself to avoid issues merging together

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/Structs/WalletMetadataList.html b/Structs/WalletMetadataList.html new file mode 100644 index 00000000..9c120ab9 --- /dev/null +++ b/Structs/WalletMetadataList.html @@ -0,0 +1,1157 @@ + + + + WalletMetadataList Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletMetadataList

+
+
+ +
public struct WalletMetadataList : Codable, Hashable
+ +
+
+

Container to store groups of WalletMetadata based on type

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/SubverifierWrapper/index.html b/SubverifierWrapper/index.html deleted file mode 100644 index af4b88f3..00000000 --- a/SubverifierWrapper/index.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - KukaiCoreSwift - SubverifierWrapper - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Subverifier​Wrapper -

- -
-
public struct SubverifierWrapper  
-
-
-

SDK requires information about the verifer that can't be stored inside the verifier, add a wrapper object to allow passing of all the data

- -
- -
-

Initializers

- -
-

- init(aggregate​Verifier​Name:​network​Type:​subverifier:​) -

-
-
public init(aggregateVerifierName: String?, networkType: TezosNodeClientConfig.NetworkType, subverifier: SubVerifierDetails)  
-
-
-

Create an instance of the object with an option string for the aggregate verifier name, and a SubVerifierDetails object

- -
-
-
-
-

Properties

- -
-

- aggregate​Verifier​Name -

-
-
public let aggregateVerifierName: String? 
-
-
-

The name of the aggregated verifier

- -
-
-
-

- network​Type -

-
-
public let networkType: TezosNodeClientConfig.NetworkType
-
-
-

Unlike seed based wallets, Torus verifiers are bound to a network and generate different addresses. In order to give the same experience on Tezos, we need to supply the network for each verifier

- -
-
-
-

- subverifier -

-
-
public let subverifier: SubVerifierDetails
-
-
-

The matching SubVerifierDetails object

- -
-
-
- - - -
-
- - - - diff --git a/TaquitoService/index.html b/TaquitoService/index.html deleted file mode 100644 index f0bc8d7b..00000000 --- a/TaquitoService/index.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - KukaiCoreSwift - TaquitoService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Taquito​Service -

- -
-
public class TaquitoService  
-
-
-

Taquito (https://github.com/ecadlabs/taquito) is a popular open source Tezos library written in Typescript and Javascript. -Taquito is made up of many separate packages that deal with various aspects of Tezos RPC and Michelson. -This serivce class is a wrapper around a small piece of the Taquito library to expose funtionality that would otherwise be time consuming/risky/dangerous to re-implement natively. -The JS can now be found on each github release here: https://github.com/ecadlabs/taquito/releases/, by extracting the zip named "taquito-local-forging-vanilla.zip"

- -
-
- - -

Nested Types

-
-
TaquitoService.TaquitoServiceError
-

Unique TaquitoService errors

-
-
-
-
-

Properties

- -
-

- shared -

-
-
public static let shared  
-
-
-

Public shared instace to avoid having multiple copies of the underlying JSContext created

- -
-
-
-
-

Methods

- -
-

- forge(operation​Payload:​completion:​) -

-
-
public func forge(operationPayload: OperationPayload, completion: @escaping((Result<String, KukaiError>) -> Void))  
-
-
-

Wrapper around the node package @taquito/local-forging's forge method. Giving the ability to locally forge an OperationPayload without using an RPC, and avoiding the need to do an RPC parse against a second server. -Note: Currently only one forge can take place at a time. Multiple simultaneous calls will result in an error being returned. -See package: https://github.com/ecadlabs/taquito/tree/master/packages/taquito-local-forging, and docs: https://tezostaquito.io/typedoc/modules/_taquito_local_forging.html

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
operation​PayloadOperation​Payload

The payload to forge. Can be constructed using OperationFactory.operationPayload(...).

-
completion@escaping((Result<String, Kukai​Error>) -> Void)

The underlying javascript code uses a Promise. In order to wrap this up into native Swift, we need to provide a completion callback to return the resulting hex string.

-
-
-
-

- parse(hex:​completion:​) -

-
-
public func parse(hex: String, completion: @escaping((Result<OperationPayload, KukaiError>) -> Void))  
-
-
-

Wrapper around the node package @taquito/local-forging's prase method. Giving the ability to locally parse a hex string back into an OperationPayload, without the need to use an RPC on a tezos node. -Note: Currently only one parse can take place at a time. Multiple simultaneous calls will result in an error being returned. -See package: https://github.com/ecadlabs/taquito/tree/master/packages/taquito-local-forging, and docs: https://tezostaquito.io/typedoc/modules/_taquito_local_forging.html

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
hexString

The string that needs to be parsed into an OperationPayload.

-
completion@escaping((Result<Operation​Payload, Kukai​Error>) -> Void)

The underlying javascript code uses a Promise. In order to wrap this up into native Swift, we need to provide a completion callback to return the resulting object

-
-
-
- - - -
-
- - - - diff --git a/TaquitoService_TaquitoServiceError/index.html b/TaquitoService_TaquitoServiceError/index.html deleted file mode 100644 index 59837571..00000000 --- a/TaquitoService_TaquitoServiceError/index.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - KukaiCoreSwift - TaquitoService.TaquitoServiceError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Taquito​Service.​Taquito​Service​Error -

- -
-
public enum TaquitoServiceError: Error  
-
-
-

Unique TaquitoService errors

- -
-
- -
- - - - - - -%455 - - - -TaquitoService.TaquitoServiceError - - -TaquitoService.TaquitoServiceError - - - - - -Error - -Error - - - -TaquitoService.TaquitoServiceError->Error - - - - - - - - -
-

Member Of

-
-
TaquitoService
-

Taquito (https://github.com/ecadlabs/taquito) is a popular open source Tezos library written in Typescript and Javascript. -Taquito is made up of many separate packages that deal with various aspects of Tezos RPC and Michelson. -This serivce class is a wrapper around a small piece of the Taquito library to expose funtionality that would otherwise be time consuming/risky/dangerous to re-implement natively. -The JS can now be found on each github release here: https://github.com/ecadlabs/taquito/releases/, by extracting the zip named "taquito-local-forging-vanilla.zip"

-
-
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- already​Forging -

-
-
case alreadyForging
-
-
-
-

- already​Parsing -

-
-
case alreadyParsing
-
-
-
- - - -
-
- - - - diff --git a/TezosDomainsAddressBulkResponse/index.html b/TezosDomainsAddressBulkResponse/index.html deleted file mode 100644 index 7399c84a..00000000 --- a/TezosDomainsAddressBulkResponse/index.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsAddressBulkResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Domains​Address​Bulk​Response -

- -
-
public struct TezosDomainsAddressBulkResponse: Codable  
-
-
-

Response object wrapper for querying an address in bulk

- -
-
- -
- - - - - - -%371 - - - -TezosDomainsAddressBulkResponse - - -TezosDomainsAddressBulkResponse - - - - - -Codable - -Codable - - - -TezosDomainsAddressBulkResponse->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(domains:​) -

-
-
public init(domains: TezosDomainsDomains?)  
-
-
-

Default init

- -
-
-
-
-

Properties

- -
-

- domains -

-
-
public let domains: TezosDomainsDomains? 
-
-
-

Object containing all the info of the record

- -
-
-
- - - -
-
- - - - diff --git a/TezosDomainsAddressResponse/index.html b/TezosDomainsAddressResponse/index.html deleted file mode 100644 index b9fac96a..00000000 --- a/TezosDomainsAddressResponse/index.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsAddressResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Domains​Address​Response -

- -
-
public struct TezosDomainsAddressResponse: Codable  
-
-
-

Response object wrapper for querying an address

- -
-
- -
- - - - - - -%119 - - - -TezosDomainsAddressResponse - - -TezosDomainsAddressResponse - - - - - -Codable - -Codable - - - -TezosDomainsAddressResponse->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(domain:​) -

-
-
public init(domain: TezosDomainsDomain)  
-
-
-

Default init

- -
-
-
-
-

Properties

- -
-

- domain -

-
-
public let domain: TezosDomainsDomain
-
-
-

Domain object containing details about the domain

- -
-
-
- - - -
-
- - - - diff --git a/TezosDomainsClient/index.html b/TezosDomainsClient/index.html deleted file mode 100644 index 1a47319c..00000000 --- a/TezosDomainsClient/index.html +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsClient - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Tezos​Domains​Client -

- -
-
public class TezosDomainsClient  
-
-
-

A client class allowing integration with the tezos domains GraphQL API. See more here: https://tezos.domains/

- -
-
- - -

Nested Types

-
-
TezosDomainsClient.BothNetworkReverseRecord
-

Object to wrap up a response fomr both networks

-
-
-
-
-

Initializers

- -
-

- init(network​Service:​config:​) -

-
-
public init(networkService: NetworkService, config: TezosNodeClientConfig)  
-
-
-

Init a TezosDomainsClient with a NetworkService and a TezosNodeClientConfig.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
network​ServiceNetwork​Service

NetworkService used to manage network communication.

-
configTezos​Node​Client​Config

TezosNodeClientConfig used to apss in settings.

-
-
-
-
-

Methods

- -
-

- get​Domain​For(address:​url:​completion:​) -

-
-
public func getDomainFor(address: String, url: URL? = nil, completion: @escaping ((Result<GraphQLResponse<TezosDomainsDomainResponse>, KukaiError>) -> Void))  
-
-
-

Get Tezos domain response for a given address

- -
-
-
-

- get​Main​And​Ghost​Domain​For(address:​completion:​) -

-
-
public func getMainAndGhostDomainFor(address: String, completion: @escaping (( Result<BothNetworkReverseRecord, KukaiError> ) -> Void))  
-
-
-

Query both mainnet and ghostnet versions of Tezos domains to find all records for the given address

- -
-
-
-

- get​Address​For(domain:​completion:​) -

-
-
public func getAddressFor(domain: String, completion: @escaping ((Result<GraphQLResponse<TezosDomainsAddressResponse>, KukaiError>) -> Void))  
-
-
-

Find the tz address of a given domain

- -
-
-
-

- get​Domains​For(addresses:​url:​completion:​) -

-
-
public func getDomainsFor(addresses: [String], url: URL? = nil, completion: @escaping ((Result<GraphQLResponse<TezosDomainsDomainBulkResponse>, KukaiError>) -> Void))  
-
-
-

Bulk function for fetching domains for an array of addresses

- -
-
-
-

- get​Main​And​Ghost​Domains​For(addresses:​completion:​) -

-
-
public func getMainAndGhostDomainsFor(addresses: [String], completion: @escaping (( Result<[String: BothNetworkReverseRecord], KukaiError> ) -> Void))  
-
-
-

Bulk function for fetching domains for an array of addresses, check ghostnet and mainnet for each

- -
-
-
-

- get​Addresses​For(domains:​completion:​) -

-
-
public func getAddressesFor(domains: [String], completion: @escaping ((Result<GraphQLResponse<TezosDomainsAddressBulkResponse>, KukaiError>) -> Void))  
-
-
-

Bulk function to find all domains for a list of addresses

- -
-
-
- - - -
-
- - - - diff --git a/TezosDomainsClient_BothNetworkReverseRecord/index.html b/TezosDomainsClient_BothNetworkReverseRecord/index.html deleted file mode 100644 index a5c459b3..00000000 --- a/TezosDomainsClient_BothNetworkReverseRecord/index.html +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsClient.BothNetworkReverseRecord - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Domains​Client.​Both​Network​Reverse​Record -

- -
-
public struct BothNetworkReverseRecord  
-
-
-

Object to wrap up a response fomr both networks

- -
-
- - -

Member Of

-
-
TezosDomainsClient
-

A client class allowing integration with the tezos domains GraphQL API. See more here: https://tezos.domains/

-
-
-
-
-

Initializers

- - -
-
-

Properties

- -
-

- mainnet -

-
-
public var mainnet: TezosDomainsReverseRecord? 
-
-
-
-

- ghostnet -

-
-
public var ghostnet: TezosDomainsReverseRecord? 
-
-
-
- - - -
-
- - - - diff --git a/TezosDomainsDomain/index.html b/TezosDomainsDomain/index.html deleted file mode 100644 index 402cfe46..00000000 --- a/TezosDomainsDomain/index.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsDomain - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Domains​Domain -

- -
-
public struct TezosDomainsDomain: Codable  
-
-
-

Domain object containing details about the domain

- -
-
- -
- - - - - - -%355 - - - -TezosDomainsDomain - - -TezosDomainsDomain - - - - - -Codable - -Codable - - - -TezosDomainsDomain->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(name:​address:​) -

-
-
public init(name: String, address: String)  
-
-
-

Default init

- -
-
-
-
-

Properties

- -
-

- name -

-
-
public let name: String
-
-
-

The domain name e.g. example.tez

- -
-
-
-

- address -

-
-
public let address: String
-
-
-

The Tezos address that the domain points too

- -
-
-
- - - -
-
- - - - diff --git a/TezosDomainsDomainBulkResponse/index.html b/TezosDomainsDomainBulkResponse/index.html deleted file mode 100644 index 85f1e59c..00000000 --- a/TezosDomainsDomainBulkResponse/index.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsDomainBulkResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Domains​Domain​Bulk​Response -

- -
-
public struct TezosDomainsDomainBulkResponse: Codable  
-
-
-

Response object wrapper for querying a reverse record in bulk

- -
-
- -
- - - - - - -%181 - - - -TezosDomainsDomainBulkResponse - - -TezosDomainsDomainBulkResponse - - - - - -Codable - -Codable - - - -TezosDomainsDomainBulkResponse->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(reverse​Records:​) -

-
-
public init(reverseRecords: TezosDomainsReverseRecords?)  
-
-
-

Default init

- -
-
-
-
-

Properties

- -
-

- reverse​Records -

-
-
public let reverseRecords: TezosDomainsReverseRecords? 
-
-
-

Object containing all the info of the record

- -
-
-
- - - -
-
- - - - diff --git a/TezosDomainsDomainResponse/index.html b/TezosDomainsDomainResponse/index.html deleted file mode 100644 index f491e576..00000000 --- a/TezosDomainsDomainResponse/index.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsDomainResponse - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Domains​Domain​Response -

- -
-
public struct TezosDomainsDomainResponse: Codable  
-
-
-

Response object wrapper for querying a reverse record

- -
-
- -
- - - - - - -%51 - - - -TezosDomainsDomainResponse - - -TezosDomainsDomainResponse - - - - - -Codable - -Codable - - - -TezosDomainsDomainResponse->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(reverse​Record:​) -

-
-
public init(reverseRecord: TezosDomainsReverseRecord?)  
-
-
-

Default init

- -
-
-
-
-

Properties

- -
-

- reverse​Record -

-
-
public let reverseRecord: TezosDomainsReverseRecord? 
-
-
-

Object containing all the info of the record

- -
-
-
-
-

Methods

- -
-

- domain() -

-
-
public func domain() -> String?  
-
-
-

Helper to extract the domain name more easily

- -
-
-
- - - -
-
- - - - diff --git a/TezosDomainsDomains/index.html b/TezosDomainsDomains/index.html deleted file mode 100644 index 7eb4f7a6..00000000 --- a/TezosDomainsDomains/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsDomains - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Domains​Domains -

- -
-
public struct TezosDomainsDomains: Codable  
-
-
-

Object containing an array of domains

- -
-
- -
- - - - - - -%621 - - - -TezosDomainsDomains - - -TezosDomainsDomains - - - - - -Codable - -Codable - - - -TezosDomainsDomains->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(items:​) -

-
-
public init(items: [TezosDomainsDomain])  
-
-
-

Default init

- -
-
-
- - - -
-
- - - - diff --git a/TezosDomainsReverseRecord/index.html b/TezosDomainsReverseRecord/index.html deleted file mode 100644 index dd0385c6..00000000 --- a/TezosDomainsReverseRecord/index.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsReverseRecord - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Domains​Reverse​Record -

- -
-
public struct TezosDomainsReverseRecord: Codable  
-
-
-

Object containing all the info of the tezos domains record

- -
-
- -
- - - - - - -%517 - - - -TezosDomainsReverseRecord - - -TezosDomainsReverseRecord - - - - - -Codable - -Codable - - - -TezosDomainsReverseRecord->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(id:​address:​owner:​expires​AtUtc:​domain:​) -

-
-
public init(id: String, address: String, owner: String, expiresAtUtc: String?, domain: TezosDomainsDomain)  
-
-
-

Default init

- -
-
-
-
-

Properties

- -
-

- id -

-
-
public let id: String
-
-
-

Uniquie id of the domain

- -
-
-
-

- address -

-
-
public let address: String
-
-
-

The address that the domain points too

- -
-
-
-

- owner -

-
-
public let owner: String
-
-
-

The address that owns the domain

- -
-
-
-

- expires​AtUtc -

-
-
public let expiresAtUtc: String? 
-
-
-

Expiration date

- -
-
-
-

- domain -

-
-
public let domain: TezosDomainsDomain
-
-
-

The domain object continaing the name and address

- -
-
-
- - - -
-
- - - - diff --git a/TezosDomainsReverseRecords/index.html b/TezosDomainsReverseRecords/index.html deleted file mode 100644 index dbbcd4e3..00000000 --- a/TezosDomainsReverseRecords/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - KukaiCoreSwift - TezosDomainsReverseRecords - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Domains​Reverse​Records -

- -
-
public struct TezosDomainsReverseRecords: Codable  
-
-
-

Object containing an array of reverse records

- -
-
- -
- - - - - - -%535 - - - -TezosDomainsReverseRecords - - -TezosDomainsReverseRecords - - - - - -Codable - -Codable - - - -TezosDomainsReverseRecords->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(items:​) -

-
-
public init(items: [TezosDomainsReverseRecord])  
-
-
-

Default init

- -
-
-
- - - -
-
- - - - diff --git a/TezosNodeClient/index.html b/TezosNodeClient/index.html deleted file mode 100644 index 5ba5cfe7..00000000 --- a/TezosNodeClient/index.html +++ /dev/null @@ -1,538 +0,0 @@ - - - - - - KukaiCoreSwift - TezosNodeClient - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Tezos​Node​Client -

- -
-
public class TezosNodeClient  
-
-
-

The TezosNodeClient offers methods for interacting with the Tezos node to fetch balances, send transactions etc. -The client will abstract away all the compelx tasks of remote forging, parsing, signing, preapply and injecting operations. -It will also convert amounts from the network into Token objects to make common tasks easier.

- -
-
- - -

Nested Types

-
-
TezosNodeClient.TezosNodeClientError
-

Types of errors

-
-
-
-
-

Initializers

- -
-

- init(config:​) -

-
-
public init(config: TezosNodeClientConfig = TezosNodeClientConfig(withDefaultsForNetworkType: .mainnet))  
-
-
-

Init a TezosNodeClient with a TezosNodeClientConfig.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
configTezos​Node​Client​Config

A configuration object containing all the necessary settings to connect and communicate with the Tezos node.

-
-
-
-
-

Properties

- -
-

- config -

-
-
public let config: TezosNodeClientConfig
-
-
-

The configuration object containing all the necessary settings to connect and communicate with the Tezos node

- -
-
-
-

- network​Service -

-
-
public var networkService: NetworkService
-
-
-

The NetworkService object that will perform all the networking calls

- -
-
-
-

- operation​Service -

-
-
public var operationService: OperationService
-
-
-

The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

- -
-
-
-

- fee​Estimator​Service -

-
-
public var feeEstimatorService: FeeEstimatorService
-
-
-

The service responsible for calculating network fees on behalf of the user

- -
-
-
-

- network​Version -

-
-
public var networkVersion: NetworkVersion? 
-
-
-

Available information about the version of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

- -
-
-
-

- network​Constants -

-
-
public var networkConstants: NetworkConstants? 
-
-
-

Available information about the constants of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

- -
-
-
-
-

Methods

- -
-

- get​Balance(for​Address:​completion:​) -

-
-
public func getBalance(forAddress address: String, completion: @escaping ((Result<XTZAmount, KukaiError>) -> Void))  
-
-
-

Gets the xtz balance for a given Address.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
for​AddressString

A Tezos network address, starting with "tz1", "tz2", "tz3" or "kt1"

-
completion@escaping ((Result<XTZAmount, Kukai​Error>) -> Void)

A callback containing a new Token object matching the xtz standard, or an error.

-
-
-
-

- get​Delegate(for​Address:​completion:​) -

-
-
public func getDelegate(forAddress address: String, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

Gets the delegate for the given address.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
for​AddressString

A Tezos network address, starting with "tz1", "tz2", "tz3" or "kt1"

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

A callback containing a String with the delegate/baker's address, or an error.

-
-
-
-

- estimate(operations:​wallet​Address:​base58Encoded​Public​Key:​completion:​) -

-
-
public func estimate(operations: [Operation], walletAddress: String, base58EncodedPublicKey: String, completion: @escaping ((Result<FeeEstimatorService.EstimationResult, KukaiError>) -> Void))  
-
-
-

Take an array of operations and estimate the gas, storage, baker fee and burn fees required to inject it onto the network -If the supplied operations contain suggested fees (e.g. from a dApp) this function will estimate the fee and pick which ever is higher

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
operations[Operation]

An array of Operation's to be injected.

-
wallet

The Wallet that will sign the operation

-
completion@escaping ((Result<Fee​Estimator​Service.​Estimation​Result, Kukai​Error>) -> Void)

A callback containing an updated array of Operation's with fees set correctly, or an error.

-
-
-
-

- send(operations:​with​Wallet:​completion:​) -

-
-
public func send(operations: [Operation], withWallet wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

Send an array of Operation's to the blockchain. Use OperationFactory to help create this array for common use cases.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
operations[Operation]

An array of Operation subclasses to be sent to the network.

-
with​WalletWallet

The Wallet instance that will sign the transactions.

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

A completion closure that will either return the opertionID of an injected operation, or an error.

-
-
-
-

- send(operation​Payload:​operation​Metadata:​with​Wallet:​completion:​) -

-
-
public func send(operationPayload: OperationPayload, operationMetadata: OperationMetadata, withWallet wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

Send an already contrsutructed OperationPayload with the necessary OperationMetadata without having to fetch metadata again.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
operation​PayloadOperation​Payload

An OperationPayload that has already been constructed (e.g. from the estimation call).

-
operation​MetadataOperation​Metadata

An OperationMetaData object containing all the info about the network that the call needs for forge -> inject.

-
with​WalletWallet

The Wallet instance that will sign the transactions.

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

A completion closure that will either return the opertionID of an injected operation, or an error.

-
-
-
-

- get​Operation​Metadata(for​Wallet​Address:​completion:​) -

-
-
public func getOperationMetadata(forWalletAddress: String, completion: @escaping ((Result<OperationMetadata, KukaiError>) -> Void))  
-
-
-

Get all the metadata necessary from the network to perform operations.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
for​Wallet

The Wallet object that will be sending the operations.

-
completion@escaping ((Result<Operation​Metadata, Kukai​Error>) -> Void)

A callback that will be executed when the network requests finish.

-
-
-
-

- get​Contract​Storage(contract​Address:​completion:​) -

-
-
public func getContractStorage(contractAddress: String, completion: @escaping ((Result<[String: Any], KukaiError>) -> Void))  
-
-
-

Get the Michelson storage of a given contract from the blockchain.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
contract​AddressString

The address of the contract to query.

-
completion@escaping ((Result<[String:​ Any], Kukai​Error>) -> Void)

A callback with a Result object, with either a [String: Any] or an Error

-
-
-
-

- get​Big​Map(id:​completion:​) -

-
-
public func getBigMap(id: String, completion: @escaping ((Result<[String: Any], KukaiError>) -> Void))  
-
-
-

Get the Michelson big map contents, from a given id

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
idString

The big map id.

-
completion@escaping ((Result<[String:​ Any], Kukai​Error>) -> Void)

A callback with a Result object, with either a [String: Any] or an Error

-
-
-
-

- get​Network​Information(completion:​) -

-
-
public func getNetworkInformation(completion: @escaping ((Bool, KukaiError?) -> Void))  
-
-
-

Query the server for the NetworkVersion and NetworkConstants, and store the responses in the tezosNodeClient properties networkVersion and networkConstants, -so they can be referred too by the application without having to constantly query t he server.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
completion@escaping ((Bool, Kukai​Error?) -> Void)

A callback with a Bool indicating success and an optional Error

-
-
-
- - - -
-
- - - - diff --git a/TezosNodeClientConfig/index.html b/TezosNodeClientConfig/index.html deleted file mode 100644 index 80d199ad..00000000 --- a/TezosNodeClientConfig/index.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - - KukaiCoreSwift - TezosNodeClientConfig - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Node​Client​Config -

- -
-
public struct TezosNodeClientConfig  
-
-
-

A configuration object used to provide settings to the TezosNodeClient

- -
-
- - -

Nested Types

-
-
TezosNodeClientConfig.NetworkType
-

An enum indicating whether the network is mainnet or testnet

-
-
TezosNodeClientConfig.ForgingType
-

Allow switching between local forging or remote forging+parsing

-
-
TezosNodeClientConfig.defaultMainnetURLs
-

Preconfigured struct with all the URL's needed to work with Tezos mainnet

-
-
TezosNodeClientConfig.defaultTestnetURLs
-

Preconfigured struct with all the URL's needed to work with Tezos testnet

-
-
-
-
-

Initializers

- -
-

- init(with​Defaults​For​Network​Type:​) -

-
-
public init(withDefaultsForNetworkType networkType: NetworkType)  
-
-
-

Init a TezosNodeClientConfig with the defaults

- -
-

Parameters

- - - - - - - - - - - - - - - - -
with​Defaults​For​Network​TypeNetwork​Type

Use the default settings for the given network type

-
-
-
-
-

Properties

- -
-

- primary​Node​URL -

-
-
public let primaryNodeURL: URL
-
-
-

The main URL used for remote forging, fetching balances, setting delegates and other forms of queries and operations.

- -
-
-
-

- parse​Node​URL -

-
-
public let parseNodeURL: URL? 
-
-
-

When using remote forging, it is essential to use a second server to verify the contents of the remote forge match what the library sent.

- -
-
-
-

- forging​Type -

-
-
public let forgingType: ForgingType
-
-
-

Controls whether to use local forging or remote forging+parsing

- -
-
-
-

- tzkt​URL -

-
-
public let tzktURL: URL
-
-
-

The URL to use for TzKTClient

- -
-
-
-

- better​Call​Dev​URL -

-
-
public let betterCallDevURL: URL
-
-
-

The URL to use for BetterCallDevClient

- -
-
-
-

- tezos​Domains​URL -

-
-
public let tezosDomainsURL: URL
-
-
-

The URL to use for TezosDomainsClient

- -
-
-
-

- objkt​Api​URL -

-
-
public let objktApiURL: URL
-
-
-

The URL to use for TezosDomainsClient

- -
-
-
-

- url​Session -

-
-
public var urlSession: URLSession
-
-
-

The URLSession that will be used for all network communication. If looking to mock this library, users should create their own URLSessionMock and pass it in.

- -
-
-
-

- network​Type -

-
-
public let networkType: NetworkType
-
-
-

The network type of the connected node

- -
-
-
-

- logging​Config -

-
-
public var loggingConfig: LoggingConfig  
-
-
-

Control what gets logged to the console

- -
-
-
-
-

Methods

- -
-

- config​With​Local​Forge(primary​Node​URL:​tzkt​URL:​better​Call​Dev​URL:​tezos​Domains​URL:​objkt​Api​URL:​url​Session:​network​Type:​) -

-
-
public static func configWithLocalForge(primaryNodeURL: URL, tzktURL: URL, betterCallDevURL: URL, tezosDomainsURL: URL, objktApiURL: URL, urlSession: URLSession, networkType: NetworkType) -> TezosNodeClientConfig  
-
-
-

Creates an instance of TezosNodeClientConfig with only the required properties needed when using local forge.

- -
-
-
    -
  • -

    returns TezosNodeClientConfig

    -
  • -
- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
primary​Node​URLURL

The URL of the primary node that will perform the majority of the network operations.

-
tzkt​URLURL

The URL to use for TzKTClient.

-
better​Call​Dev​URLURL

The URL to use for BetterCallDevClient.

-
url​SessionURLSession

The URLSession object that will perform all the network operations.

-
network​TypeNetwork​Type

Enum indicating the network type.

-
-
-
-

- config​With​Remote​Forge(primary​Node​URL:​parse​Node​URL:​tzkt​URL:​better​Call​Dev​URL:​tezos​Domains​URL:​objkt​Api​URL:​url​Session:​network​Type:​) -

-
-
public static func configWithRemoteForge(primaryNodeURL: URL, parseNodeURL: URL, tzktURL: URL, betterCallDevURL: URL, tezosDomainsURL: URL, objktApiURL: URL, urlSession: URLSession, networkType: NetworkType) -> TezosNodeClientConfig  
-
-
-

Creates an instance of TezosNodeClientConfig with the required properties for remote forging. Note: function will casue a fatalError is users attempt to set primaryNodeURL and parseNodeURL to the same destination

- -
-
-
    -
  • -

    returns TezosNodeClientConfig

    -
  • -
- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
primary​Node​URLURL

The URL of the primary node that will perform the majority of the network operations.

-
parse​Node​URLURL

The URL to use to parse and verify a remote forge. Must be a different server to primary node.

-
tzkt​URLURL

The URL to use for TzKTClient.

-
better​Call​Dev​URLURL

The URL to use for BetterCallDevClient.

-
url​SessionURLSession

The URLSession object that will perform all the network operations.

-
network​TypeNetwork​Type

Enum indicating the network type.

-
-
-
- - - -
-
- - - - diff --git a/TezosNodeClientConfig_ForgingType/index.html b/TezosNodeClientConfig_ForgingType/index.html deleted file mode 100644 index b2148c0e..00000000 --- a/TezosNodeClientConfig_ForgingType/index.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - KukaiCoreSwift - TezosNodeClientConfig.ForgingType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Tezos​Node​Client​Config.​Forging​Type -

- -
-
public enum ForgingType: String  
-
-
-

Allow switching between local forging or remote forging+parsing

- -
-
- -
- - - - - - -%401 - - - -TezosNodeClientConfig.ForgingType - - -TezosNodeClientConfig.ForgingType - - - - - -String - -String - - - -TezosNodeClientConfig.ForgingType->String - - - - - - - - -
-

Member Of

-
-
TezosNodeClientConfig
-

A configuration object used to provide settings to the TezosNodeClient

-
-
-

Conforms To

-
-
String
-
-
-
-

Enumeration Cases

- -
-

- local -

-
-
case local
-
-
-
-

- remote -

-
-
case remote
-
-
-
- - - -
-
- - - - diff --git a/TezosNodeClientConfig_NetworkType/index.html b/TezosNodeClientConfig_NetworkType/index.html deleted file mode 100644 index ce6fe60e..00000000 --- a/TezosNodeClientConfig_NetworkType/index.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - KukaiCoreSwift - TezosNodeClientConfig.NetworkType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Tezos​Node​Client​Config.​Network​Type -

- -
-
public enum NetworkType: String  
-
-
-

An enum indicating whether the network is mainnet or testnet

- -
-
- -
- - - - - - -%605 - - - -TezosNodeClientConfig.NetworkType - - -TezosNodeClientConfig.NetworkType - - - - - -String - -String - - - -TezosNodeClientConfig.NetworkType->String - - - - - - - - -
-

Member Of

-
-
TezosNodeClientConfig
-

A configuration object used to provide settings to the TezosNodeClient

-
-
-

Conforms To

-
-
String
-
-
-
-

Enumeration Cases

- -
-

- mainnet -

-
-
case mainnet
-
-
-
-

- testnet -

-
-
case testnet
-
-
-
- - - -
-
- - - - diff --git a/TezosNodeClientConfig_defaultMainnetURLs/index.html b/TezosNodeClientConfig_defaultMainnetURLs/index.html deleted file mode 100644 index 8fe790fc..00000000 --- a/TezosNodeClientConfig_defaultMainnetURLs/index.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - KukaiCoreSwift - TezosNodeClientConfig.defaultMainnetURLs - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Node​Client​Config.​default​Mainnet​URLs -

- -
-
public struct defaultMainnetURLs  
-
-
-

Preconfigured struct with all the URL's needed to work with Tezos mainnet

- -
-
- - -

Member Of

-
-
TezosNodeClientConfig
-

A configuration object used to provide settings to the TezosNodeClient

-
-
-
-
-

Properties

- -
-

- primary​Node​URL -

-
-
public static let primaryNodeURL = URL(string: "https://mainnet-tezos.giganode.io/")! 
-
-
-

The default mainnet URL to use for primaryNodeURL, For more information on the free service, see: https://tezos.giganode.io/

- -
-
-
-

- parse​Node​URL -

-
-
public static let parseNodeURL = URL(string: "https://tezos-prod.cryptonomic-infra.tech:443/")! 
-
-
-

The default mainnet URL to use for parseNodeURL, For more information on the free service, see: https://nautilus.cloud/

- -
-
-
-

- tzkt​URL -

-
-
public static let tzktURL = URL(string: "https://api.tzkt.io/")! 
-
-
-

The default mainnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

- -
-
-
-

- better​Call​Dev​URL -

-
-
public static let betterCallDevURL = URL(string: "https://api.better-call.dev/")! 
-
-
-

The default mainnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

- -
-
-
-

- tezos​Domains​URL -

-
-
public static let tezosDomainsURL = URL(string: "https://api.tezos.domains/graphql")! 
-
-
-

The default mainnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

- -
-
-
-

- objkt​Api​URL -

-
-
public static let objktApiURL = URL(string: "https://data.objkt.com/v3/graphql")! 
-
-
-

The default mainnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

- -
-
-
- - - -
-
- - - - diff --git a/TezosNodeClientConfig_defaultTestnetURLs/index.html b/TezosNodeClientConfig_defaultTestnetURLs/index.html deleted file mode 100644 index a395d70b..00000000 --- a/TezosNodeClientConfig_defaultTestnetURLs/index.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - KukaiCoreSwift - TezosNodeClientConfig.defaultTestnetURLs - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Tezos​Node​Client​Config.​default​Testnet​URLs -

- -
-
public struct defaultTestnetURLs  
-
-
-

Preconfigured struct with all the URL's needed to work with Tezos testnet

- -
-
- - -

Member Of

-
-
TezosNodeClientConfig
-

A configuration object used to provide settings to the TezosNodeClient

-
-
-
-
-

Properties

- -
-

- primary​Node​URL -

-
-
public static let primaryNodeURL = URL(string: "https://rpc.ghostnet.teztnets.xyz")! 
-
-
-

The default mainnet URL to use for primaryNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about

- -
-
-
-

- parse​Node​URL -

-
-
public static let parseNodeURL = URL(string: "https://rpc.ghostnet.teztnets.xyz")! 
-
-
-

The default testnet URL to use for parseNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about -When using remote forging on mainnet, you should use two seperate servers on seperate networks for security reasons

- -
-
-
-

- tzkt​URL -

-
-
public static let tzktURL = URL(string: "https://api.ghostnet.tzkt.io/")! 
-
-
-

The default testnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

- -
-
-
-

- better​Call​Dev​URL -

-
-
public static let betterCallDevURL = URL(string: "https://api.better-call.dev/")! 
-
-
-

The default testnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

- -
-
-
-

- tezos​Domains​URL -

-
-
public static let tezosDomainsURL = URL(string: "https://ghostnet-api.tezos.domains/graphql")! 
-
-
-

The default testnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

- -
-
-
-

- objkt​Api​URL -

-
-
public static let objktApiURL = URL(string: "https://data.objkt.com/v3/graphql")! 
-
-
-

The default testnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

- -
-
-
- - - -
-
- - - - diff --git a/TezosNodeClient_TezosNodeClientError/index.html b/TezosNodeClient_TezosNodeClientError/index.html deleted file mode 100644 index ec6fee09..00000000 --- a/TezosNodeClient_TezosNodeClientError/index.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - KukaiCoreSwift - TezosNodeClient.TezosNodeClientError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Tezos​Node​Client.​Tezos​Node​Client​Error -

- -
-
public enum TezosNodeClientError: Error  
-
-
-

Types of errors

- -
-
- -
- - - - - - -%11 - - - -TezosNodeClient.TezosNodeClientError - - -TezosNodeClient.TezosNodeClientError - - - - - -Error - -Error - - - -TezosNodeClient.TezosNodeClientError->Error - - - - - - - - -
-

Member Of

-
-
TezosNodeClient
-

The TezosNodeClient offers methods for interacting with the Tezos node to fetch balances, send transactions etc. -The client will abstract away all the compelx tasks of remote forging, parsing, signing, preapply and injecting operations. -It will also convert amounts from the network into Token objects to make common tasks easier.

-
-
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- no​Dexter​Exchange​Address​Found -

-
-
case noDexterExchangeAddressFound
-
-
-
-

- michelson​Parsing -

-
-
case michelsonParsing
-
-
-
- - - -
-
- - - - diff --git a/Thread/index.html b/Thread/index.html deleted file mode 100644 index 1a8d5895..00000000 --- a/Thread/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - KukaiCoreSwift - Thread - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Extensions on - Thread -

-
-

Properties

- -
-

- is​Running​XCTest -

-
-
var isRunningXCTest: Bool  
-
-
-

Check if the given thread is being run from inside an XCTest bundle

- -
-
-
-
-
- - - - diff --git a/Token/index.html b/Token/index.html deleted file mode 100644 index ca12e7cf..00000000 --- a/Token/index.html +++ /dev/null @@ -1,581 +0,0 @@ - - - - - - KukaiCoreSwift - Token - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Token -

- -
-
public class Token: Codable, CustomStringConvertible  
-
-
-

A class to represent a Token on the Tezos network. This class will do all the heavy lifting of converting values from the RPC to more human readbale values. -This class will also handle arithmetic functions, allowing developers to add and subtract tokens (useful when caluclating fees and total values).

- -
-
- -
- - - - - - -%699 - - - -Token - - -Token - - - - - -Codable - -Codable - - - -Token->Codable - - - - - -CustomStringConvertible - -CustomStringConvertible - - - -Token->CustomStringConvertible - - - - - -Identifiable - -Identifiable - - - -Token->Identifiable - - - - - -Equatable - -Equatable - - - -Token->Equatable - - - - - -Hashable - -Hashable - - - -Token->Hashable - - - - - - - - -
-

Nested Types

-
-
Token.TokenType
-

An Enum to express the type of a token. Different processes are needed to fetch a balance for a users XTZ wallet, -versus fetching a FA1.2 token balance. This allows the library to abstract this logic away from the user and handle it all behind the scenes.

-
-
-

Conforms To

-
-
Codable
-
CustomStringConvertible
-
Equatable
-
Hashable
-
Identifiable
-
-
-
-

Initializers

- -
-

- init(name:​symbol:​token​Type:​fa​Version:​balance:​thumbnail​URL:​token​Contract​Address:​token​Id:​nfts:​minting​Tool:​) -

-
-
public init(name: String?, symbol: String, tokenType: TokenType, faVersion: FaVersion?, balance: TokenAmount, thumbnailURL: URL?, tokenContractAddress: String?, tokenId: Decimal?, nfts: [NFT]?, mintingTool: String?)  
-
-
-

Init a Token object that will hold all the necessary data to interact with the Tezos network, and the Dexter exchange

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
nameString?

The long name of the token. e.g. "Tezos"

-
symbolString

The short name of the token, or the symbol. e.g. "XTZ"

-
token​TypeToken​Type

The type of the token. e.g. xtz, fa1.2, fa2 etc.

-
fa​VersionFaVersion?

The FA standard / version used to create this token.

-
decimal​Places

The number of decimal places this token contains.

-
thumbnail​URI

URI to network asset to use to display an icon for the token

-
token​Contract​AddressString?

The KT1 address of the contract (nil if xtz).

-
token​IdDecimal?

The token id if the token is an FA2 token, nil otherwise.

-
nfts[NFT]?

The individual NFT's owned of this token type

-
-
-
-

- init(from:​and​Token​Amount:​) -

-
-
public init(from: TzKTBalanceToken, andTokenAmount: TokenAmount)  
-
-
-

Init a Token from an object returned by the TzKT API

- -
-
-
-

- init(from:​) -

-
-
public init(from: TzKTTokenTransfer)  
-
-
-

Init a Token from an object returned by the TzKT API

- -
-
-
-
-

Properties

- -
-

- name -

-
-
public let name: String? 
-
-
-

The long name of a token. e.g. "Tezos".

- -
-
-
-

- symbol -

-
-
public let symbol: String
-
-
-

The short name or the symbol of a token. e.g. "XTZ".

- -
-
-
-

- token​Type -

-
-
public let tokenType: TokenType
-
-
-

The type of this token. e.g. xtz, fungible, nonfungible

- -
-
-
-

- fa​Version -

-
-
public let faVersion: FaVersion? 
-
-
-

The FaVersion of the token contract, nil for XTZ

- -
-
-
-

- balance -

-
-
public var balance: TokenAmount
-
-
-

Object that holds and formats the balance of the token

- -
-
-
-

- decimal​Places -

-
-
public var decimalPlaces: Int  
-
-
-

Get the underlying number of decimal places that this token represents

- -
-
-
-

- thumbnail​URL -

-
-
public var thumbnailURL: URL? = nil
-
-
-

The URL to a cached version of the asset (data that we add later on through other service calls)

- -
-
-
-

- local​Currency​Rate -

-
-
public var localCurrencyRate: Decimal = 0
-
-
-

The current local currency rate of this token. Used to show the user the net worth of their holdings.

- -
-
-
-

- token​Contract​Address -

-
-
public let tokenContractAddress: String? 
-
-
-

In the case of FA1.2 or higher, we need to know the KT1 address for the token so we can fetch balances and make trades. (should be empty for xtz).

- -
-
-
-

- token​Id -

-
-
public var tokenId: Decimal? 
-
-
-

Each token type on a contract will have a unique token_id

- -
-
-
-

- is​Hidden -

-
-
public var isHidden: Bool = false
-
-
-

Recording if the user has marked the token as hidden

- -
-
-
-

- favourite​Sort​Index -

-
-
public var favouriteSortIndex: Int? = nil
-
-
-

Recording if the position the index the user chose for the favourite token to appear

- -
-
-
-

- nfts -

-
-
public var nfts: [NFT]? 
-
-
-

The individual NFT's owned of this token type

- -
-
-
-

- minting​Tool -

-
-
public var mintingTool: String? 
-
-
-

The URL of the tool used to mint the item

- -
-
-
-

- is​Favourite -

-
-
public var isFavourite: Bool  
-
-
-
-

- description -

-
-
public var description: String  
-
-
-

Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

- -
-
-
-

- id -

-
-
public var id: String  
-
-
-

Conforming to Identifiable to enable working with ForEach and similiar looping functions -if faVersion present, use that to follow the standard of either tokenAddress or combination of tokenAddress + token id, fallback to using symbol if type is unknown

- -
-
-
-
-

Methods

- -
-

- xtz() -

-
-
public static func xtz() -> Token  
-
-
-

Create a Token object with all the settings needed for XTZ

- -
-

Returns

-

Token

- -
-
-

- xtz(with​Amount:​) -

-
-
public static func xtz(withAmount amount: TokenAmount) -> Token  
-
-
-

Create a Token object with all the settings needed for XTZ, with an initial amount. Useful for setting fees.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
with​AmountToken​Amount

The Amount of XTZ to create the Token with.

-
-

Returns

-

Token.

- -
-
-

- placeholder(from​NFT:​amount:​thumbnail​URL:​) -

-
-
public static func placeholder(fromNFT nft: NFT, amount: TokenAmount, thumbnailURL: URL?) -> Token  
-
-
-

Useful for creating placeholders for pending activity items

- -
-
-
-

- is​XTZ() -

-
-
public func isXTZ() -> Bool  
-
-
-

Helper function to check if the Token instance being passed aroun is pointing to XTZ. As many functions will require different functionality for fa token versus XTZ

- -
-
-
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-

Conforming to Hashable to enable working with UITableViewDiffableDataSource

- -
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: Token, rhs: Token) -> Bool  
-
-
-

Conforming to Equatable to enable working with UITableViewDiffableDataSource

- -
-
-
- - - -
-
- - - - diff --git a/TokenAmount/index.html b/TokenAmount/index.html deleted file mode 100644 index b43bc8ca..00000000 --- a/TokenAmount/index.html +++ /dev/null @@ -1,596 +0,0 @@ - - - - - - KukaiCoreSwift - TokenAmount - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Token​Amount -

- -
-
public class TokenAmount: Codable  
-
-
-

Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length. -This class is used to encapsulate a BigInt and provide all the necessary init's and formatting functions to work with the networks requirements.

- -
-
- -
- - - - - - -%647 - - - -TokenAmount - - -TokenAmount - - - - - -Codable - -Codable - - - -TokenAmount->Codable - - - - - -CustomStringConvertible - -CustomStringConvertible - - - -TokenAmount->CustomStringConvertible - - - - - -Comparable - -Comparable - - - -TokenAmount->Comparable - - - - - -Equatable - -Equatable - - - -TokenAmount->Equatable - - - - - -Hashable - -Hashable - - - -TokenAmount->Hashable - - - - - -XTZAmount - - -XTZAmount - - - - - -XTZAmount->TokenAmount - - - - - - - - -
-

Nested Types

-
-
TokenAmount.TokenAmountError
-
-
-

Subclasses

-
-
XTZAmount
-

A subclass of TokenAmount to make it more explict when functions require XTZ (such as network fees). -It also serves as a means to more quickly create TokenAmount's conforming to XTZ.

-
-
-

Conforms To

-
-
Codable
-
Comparable
-
CustomStringConvertible
-
Equatable
-
Hashable
-
-
-
-

Initializers

- -
-

- init?(from​Rpc​Amount:​decimal​Places:​) -

-
-
public init?(fromRpcAmount rpcAmount: String, decimalPlaces: Int)  
-
-
-

Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. "1 XTZ" to the user = "1000000" to the RPC, as there are no such thing as decimal places on the network

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​Rpc​AmountString

A string conforming to the RPC standard for the given token.

-
-
-
-

- init?(from​Rpc​Amount:​decimal​Places:​) -

-
-
public convenience init?(fromRpcAmount rpcAmount: Decimal, decimalPlaces: Int)  
-
-
-

Set the internal balance, using a decimal version of an RPC amount. e.g. "1 XTZ" to the user = "1000000" to the RPC, as there are no such thing as decimal places on the network

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​Rpc​AmountDecimal

A decimal conforming to the RPC standard for the given token. Decimal places will be ignored.

-
-
-
-

- init(from​Normalised​Amount:​decimal​Places:​) -

-
-
public init(fromNormalisedAmount normalisedAmount: Decimal, decimalPlaces: Int)  
-
-
-

Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​Normalised​AmountDecimal

A decimal containing an amount for the given token. Anything over the given decimal places for the token will be ignored.

-
-
-
-

- init?(from​Normalised​Amount:​decimal​Places:​) -

-
-
public convenience init?(fromNormalisedAmount normalisedAmount: String, decimalPlaces: Int)  
-
-
-

Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​Normalised​AmountString

A string containing an amount for the given token. Anything over the given decimal places for the token will be ignored.

-
-
-
-

- init(from:​) -

-
-
required public init(from decoder: Decoder) throws  
-
-
-

Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info. -This coder attempts to handle both states, first checking if its possible to extract both, if not, defaulting the decimal palces to zero, expecting the calling application to provide this information later on from another proptery or even another API call (such as a metadata query)

- -
-
-
-
-

Properties

- -
-

- decimal​Places -

-
-
public var decimalPlaces: Int
-
-
-

The number of decimal places that this token supports.

- -
-
-
-

- rpc​Representation -

-
-
public var rpcRepresentation: String  
-
-
-

Format the internal value to ensure it matches the format the RPC will expect

- -
-
-
-

- normalised​Representation -

-
-
public var normalisedRepresentation: String  
-
-
-

Basic formatting of a token to be human readable. For more advanced options, use the format function

- -
-
-
-

- description -

-
-
public var description: String  
-
-
-

Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

- -
-
-
-
-

Methods

- -
-

- zero() -

-
-
public class func zero() -> TokenAmount  
-
-
-

Quickly create a TokenAmount with zero balance and no decimal places. -Warning: the decimal places attribute could be used by other code to determine precision. This should only be used in places where it is needed as a temporary, default value.

- -
-
-
-

- zero​Balance(decimal​Places:​) -

-
-
public class func zeroBalance(decimalPlaces: Int) -> TokenAmount  
-
-
-

Quickly create a TokenAmount with zero balance.

- -
-
-
-

- encode(to:​) -

-
-
public func encode(to encoder: Encoder) throws  
-
-
-
-

- format​Normalised​Representation(locale:​) -

-
-
public func formatNormalisedRepresentation(locale: Locale) -> String?  
-
-
-

Format the current value into a human readable string, using the given locale.

- -
-

Parameters

- - - - - - - - - - - - - - - - -
localeLocale

The locale to use to decide whether to use decimal or comma, comma or spaces etc, when formattting the number

-
-
-
-

- to​Rpc​Decimal() -

-
-
public func toRpcDecimal() -> Decimal?  
-
-
-

Function to convert the underlying rpc value into a Decimal which can be useful in some situations for integrating with other tools and frameworks. -Warning Decimal has a limited, lower treshold (163 digits). Its possible it can overrun, hence the optional return value.

- -
-
-
-

- to​Normalised​Decimal() -

-
-
public func toNormalisedDecimal() -> Decimal?  
-
-
-

Function to convert the underlying normalised value into a Decimal which can be useful in some situations for integrating with other tools and frameworks. -Warning Decimal has a limited, lower treshold (163 digits). Its possible it can overrun, hence the optional return value.

- -
-
-
-

- to​XTZAmount() -

-
-
public func toXTZAmount() -> XTZAmount  
-
-
-

Currently we are unable to cast directly from TokenAmount to XTZAmount. This function will create a new XTZAmount object from the TokenAmount. -THis is useful in situations where an amount is passed in a generic manner as a TokenAmount, but its required to be an XTZAmount

- -
-
-
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-

Conforming to Hashable to enable working with UITableViewDiffableDataSource

- -
-
-
-
-

Operators

- -
-

- + -

-
-
public static func + (lhs: TokenAmount, rhs: TokenAmount) -> TokenAmount  
-
-
-

Overload + operator to allow users to add two Token amounts of the same type, together.

- -
-
-
-

- += -

-
-
public static func += (lhs: inout TokenAmount, rhs: TokenAmount)  
-
-
-

Overload += operator to allow users to add two Token amounts of the same type, together in place.

- -
-
-
-

- - -

-
-
public static func - (lhs: TokenAmount, rhs: TokenAmount) -> TokenAmount  
-
-
-

Overload - operator to allow users to subtract two Token amounts of the same type.

- -
-
-
-

- -= -

-
-
public static func -= (lhs: inout TokenAmount, rhs: TokenAmount)  
-
-
-

Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

- -
-
-
-

- * -

-
-
public static func * (lhs: TokenAmount, rhs: Decimal) -> Decimal  
-
-
-

Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

- -
-
-
-

- * -

-
-
public static func * (lhs: TokenAmount, rhs: Int) -> TokenAmount  
-
-
-

Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

- -
-
-
-

- < -

-
-
public static func < (lhs: TokenAmount, rhs: TokenAmount) -> Bool  
-
-
-

Conforming to Comparable

- -
-
-
-

- == -

-
-
public static func == (lhs: TokenAmount, rhs: TokenAmount) -> Bool  
-
-
-

Conforming to Equatable

- -
-
-
- - - -
-
- - - - diff --git a/TokenAmount_TokenAmountError/index.html b/TokenAmount_TokenAmountError/index.html deleted file mode 100644 index 599c7aa9..00000000 --- a/TokenAmount_TokenAmountError/index.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - KukaiCoreSwift - TokenAmount.TokenAmountError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Token​Amount.​Token​Amount​Error -

- -
-
public enum TokenAmountError: Error  
-
-
- -
- - - - - - -%781 - - - -TokenAmount.TokenAmountError - - -TokenAmount.TokenAmountError - - - - - -Error - -Error - - - -TokenAmount.TokenAmountError->Error - - - - - - - - -
-

Member Of

-
-
TokenAmount
-

Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length. -This class is used to encapsulate a BigInt and provide all the necessary init's and formatting functions to work with the networks requirements.

-
-
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- invalid​String​From​RPC -

-
-
case invalidStringFromRPC
-
-
-
- - - -
-
- - - - diff --git a/Token_TokenType/index.html b/Token_TokenType/index.html deleted file mode 100644 index 83051361..00000000 --- a/Token_TokenType/index.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - KukaiCoreSwift - Token.TokenType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Token.​Token​Type -

- -
-
public enum TokenType: String, Codable  
-
-
-

An Enum to express the type of a token. Different processes are needed to fetch a balance for a users XTZ wallet, -versus fetching a FA1.2 token balance. This allows the library to abstract this logic away from the user and handle it all behind the scenes.

- -
-
- -
- - - - - - -%109 - - - -Token.TokenType - - -Token.TokenType - - - - - -Codable - -Codable - - - -Token.TokenType->Codable - - - - - -String - -String - - - -Token.TokenType->String - - - - - - - - -
-

Member Of

-
-
Token
-

A class to represent a Token on the Tezos network. This class will do all the heavy lifting of converting values from the RPC to more human readbale values. -This class will also handle arithmetic functions, allowing developers to add and subtract tokens (useful when caluclating fees and total values).

-
-
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- xtz -

-
-
case xtz
-
-
-
-

- fungible -

-
-
case fungible
-
-
-
-

- nonfungible -

-
-
case nonfungible
-
-
-
- - - -
-
- - - - diff --git a/TorusAuthError/index.html b/TorusAuthError/index.html deleted file mode 100644 index 7fb43366..00000000 --- a/TorusAuthError/index.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - KukaiCoreSwift - TorusAuthError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Torus​Auth​Error -

- -
-
public enum TorusAuthError: Error  
-
-
-

Custom TorusAuthService errors that cna be thrown

- -
-
- -
- - - - - - -%217 - - - -TorusAuthError - - -TorusAuthError - - - - - -Error - -Error - - - -TorusAuthError->Error - - - - - - - - -
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- missing​Verifier -

-
-
case missingVerifier
-
-
-
-

- invalid​Torus​Response -

-
-
case invalidTorusResponse
-
-
-
-

- crypto​Error -

-
-
case cryptoError
-
-
-
-

- invalid​Node​Details -

-
-
case invalidNodeDetails
-
-
-
-

- invalid​Twitter​URL -

-
-
case invalidTwitterURL
-
-
-
-

- no​Twiiter​User​IdFound -

-
-
case noTwiiterUserIdFound
-
-
-
-

- invalid​Apple​Response -

-
-
case invalidAppleResponse
-
-
-
- - - -
-
- - - - diff --git a/TorusAuthProvider/index.html b/TorusAuthProvider/index.html deleted file mode 100644 index 6b144e52..00000000 --- a/TorusAuthProvider/index.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - KukaiCoreSwift - TorusAuthProvider - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Torus​Auth​Provider -

- -
-
public enum TorusAuthProvider: String, Codable  
-
-
-

List of providers currently supported and available on the Tezos network

- -
-
- -
- - - - - - -%191 - - - -TorusAuthProvider - - -TorusAuthProvider - - - - - -String - -String - - - -TorusAuthProvider->String - - - - - -Codable - -Codable - - - -TorusAuthProvider->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- apple -

-
-
case apple
-
-
-
-

- google -

-
-
case google
-
-
-
-

- facebook -

-
-
case facebook
-
-
-
-

- twitter -

-
-
case twitter
-
-
-
-

- reddit -

-
-
case reddit
-
-
-
-

- discord -

-
-
case discord
-
-
-
-

- twitch -

-
-
case twitch
-
-
-
-

- line -

-
-
case line
-
-
-
-

- github -

-
-
case github
-
-
-
- - - -
-
- - - - diff --git a/TorusAuthService/index.html b/TorusAuthService/index.html deleted file mode 100644 index 8952e20b..00000000 --- a/TorusAuthService/index.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - KukaiCoreSwift - TorusAuthService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Torus​Auth​Service -

- -
-
public class TorusAuthService: NSObject  
-
-
-

TorusAuthService is a wrapper around the SDK provided by: https://tor.us/ to allow the creation of TorusWallet's. -This allows users to create a wallet from their social media accounts without having to use a seed phrase / mnemonic. -TorusAuthService allows Tezos apps to leverage this service for a number of providers, and also has the ability to query the network for someone else's wallet address, -based on their social profile. This allows you to send XTZ or tokens to your friend based on their twitter username for example

- -
-
- -
- - - - - - -%315 - - - -TorusAuthService - - -TorusAuthService - - - - - -ASAuthorizationControllerDelegate - -ASAuthorizationControllerDelegate - - - -TorusAuthService->ASAuthorizationControllerDelegate - - - - - -ASAuthorizationControllerPresentationContextProviding - -ASAuthorizationControllerPresentationContextProviding - - - -TorusAuthService->ASAuthorizationControllerPresentationContextProviding - - - - - -NSObject - -NSObject - - - -TorusAuthService->NSObject - - - - - - - - -
-

Conforms To

-
-
ASAuthorizationControllerDelegate
-
ASAuthorizationControllerPresentationContextProviding
-
NSObject
-
-
-
-

Initializers

- -
-

- init(network​Service:​verifiers:​) -

-
-
public init(networkService: NetworkService, verifiers: [TorusAuthProvider: SubverifierWrapper])  
-
-
-

Setup the TorusAuthService verifiers and networking clients for testnet and mainnet, so they can be queried easier.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
network​ServiceNetwork​Service

A networking service instance used for converting twitter handles into twitter id's

-
verifiers[Torus​Auth​Provider:​ Subverifier​Wrapper]

List of verifiers available to the library for the given app context

-
-
-
-
-

Methods

- -
-

- create​Wallet(from:​display​Over:​mocked​Torus:​completion:​) -

-
-
public func createWallet(from authType: TorusAuthProvider, displayOver: UIViewController?, mockedTorus: CustomAuth? = nil, completion: @escaping ((Result<TorusWallet, KukaiError>) -> Void))  
-
-
-

Create a TorusWallet insteace from a social media provider

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
fromTorus​Auth​Provider

The TorusAuthProvider that you want to invoke

-
display​OverUIView​Controller?

The UIViewController that the webpage will display on top of

-
mocked​TorusCustom​Auth?

To avoid issues attempting to stub aspects of the Torus SDK, a mocked version of the SDK can be supplied instead

-
completion@escaping ((Result<Torus​Wallet, Kukai​Error>) -> Void)

The callback returned when all the networking and cryptography is complete

-
-
-
-

- get​Address(from:​for:​completion:​) -

-
-
public func getAddress(from authType: TorusAuthProvider, for socialUsername: String, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

Get a TZ2 address from a social media user name. If Twitter, will first convert the username to a userid and then query

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
fromTorus​Auth​Provider

The TorusAuthProvider that you want to invoke

-
forString

The social media username to search for

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

The callback returned when all the networking and cryptography is complete

-
-
-
-

- twitter​Lookup(username:​completion:​) -

-
-
public func twitterLookup(username: String, completion: @escaping ((Result<String, KukaiError>) -> Void))  
-
-
-

Take in a Twitter username and fetch the Twitter userId instead.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
usernameString

The users username. Can contain an @ symbol, but will be stripped out by the code as its not required

-
completion@escaping ((Result<String, Kukai​Error>) -> Void)

The callback fired when the userId has been found

-
-
-
-

- presentation​Anchor(for:​) -

-
-
public func presentationAnchor(for controller: ASAuthorizationController) -> ASPresentationAnchor  
-
-
-
-

- authorization​Controller(controller:​did​Complete​With​Error:​) -

-
-
public func authorizationController(controller: ASAuthorizationController, didCompleteWithError error: Error)  
-
-
-
-

- authorization​Controller(controller:​did​Complete​With​Authorization:​) -

-
-
public func authorizationController(controller: ASAuthorizationController, didCompleteWithAuthorization authorization: ASAuthorization)  
-
-
-
- - - -
-
- - - - diff --git a/TorusWallet/index.html b/TorusWallet/index.html deleted file mode 100644 index 1c332fcf..00000000 --- a/TorusWallet/index.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - KukaiCoreSwift - TorusWallet - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Torus​Wallet -

- -
-
public class TorusWallet: RegularWallet  
-
-
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

- -
-
-

This wallet is a subclass of LinearWallet created by using the Torus network to generate wallets from social media accounts. -This class is equivalent to a LinearWallet producing a TZ2 address via secp256k1, without the use of a mnemonic, and instead including the social profile of the user.

- -
-
- -
- - - - - - -%559 - - - -TorusWallet - - -TorusWallet - - - - - -RegularWallet - - -RegularWallet - - - - - -TorusWallet->RegularWallet - - - - - - - - -
-

Superclass

-
-
RegularWallet
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

-
-
-
-
-

Initializers

- -
-

- init?(auth​Provider:​username:​user​Id:​profile​Picture:​torus​Private​Key:​) -

-
-
public init?(authProvider: TorusAuthProvider, username: String?, userId: String?, profilePicture: String?, torusPrivateKey: String)  
-
-
-

Create an instace of the wallet from the data provided by the Torus network, using TorusAuthService

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
auth​ProviderTorus​Auth​Provider

The supported provider used to create the private key

-
usernameString?

Optional, the users social profile username

-
user​IdString?

Optional, the users social profile unique id

-
profile​PictureString?

Optional, the users social profile display image

-
torus​Private​KeyString

The hex encoded private key from the Torus network

-
-
-
-
-

Properties

- -
-

- auth​Provider -

-
-
public let authProvider: TorusAuthProvider
-
-
-

The type of service used to generate the provide key

- -
-
-
-

- social​Username -

-
-
public let socialUsername: String? 
-
-
-

The raw social media username displayed on the users account. In the case of Twitter, it will not be prefix with an @

- -
-
-
-

- social​User​Id -

-
-
public let socialUserId: String? 
-
-
-

The unique id the social media platform has assigned to the users account. Used for querying account details

- -
-
-
-

- social​Profile​Picture​URL -

-
-
public let socialProfilePictureURL: URL? 
-
-
-

A URL to the users profile picture on the given social meida platform

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public override func encode(to encoder: Encoder) throws  
-
-
-

Encodable encode func

- -
-
-
- - - -
-
- - - - diff --git a/Typealiases.html b/Typealiases.html new file mode 100644 index 00000000..8f281130 --- /dev/null +++ b/Typealiases.html @@ -0,0 +1,834 @@ + + + + Type Aliases Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Type Aliases

+

The following type aliases are available globally.

+ +
+
+
+
    +
  • +
    + + + + UIImage + +
    +
    +
    +
    +
    +
    +

    Create “UIImage” as typealias of NSImage

    + +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper object around the network response

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias QuipuswapExchangeLedgerKeyResponse = [QuipuswapExchangeLedgerKey]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper object around the network response

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias QuipuswapExchangeUserRewardsKeyResponse = [QuipuswapExchangeUserRewardsKey]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NanoTez + +
    +
    +
    +
    +
    +
    +

    typealias to make it clearer when we are using NanoTez, which only is only used for fee calcualtion

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias NanoTez = Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/TzKTAccount/index.html b/TzKTAccount/index.html deleted file mode 100644 index 351e528a..00000000 --- a/TzKTAccount/index.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTAccount - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTAccount -

- -
-
public struct TzKTAccount: Codable, Equatable  
-
-
-

Model mapping to TzKT.io's Account object

- -
-
- -
- - - - - - -%637 - - - -TzKTAccount - - -TzKTAccount - - - - - -Equatable - -Equatable - - - -TzKTAccount->Equatable - - - - - -Codable - -Codable - - - -TzKTAccount->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Equatable
-
-
-
-

Initializers

- -
-

- init(balance:​type:​address:​public​Key:​revealed:​delegate:​delegation​Level:​active​Tokens​Count:​token​Balances​Count:​) -

-
-
public init(balance: Decimal?, type: String, address: String, publicKey: String, revealed: Bool, delegate: TzKTAccountDelegate?, delegationLevel: Decimal?, activeTokensCount: Decimal?, tokenBalancesCount: Decimal?)  
-
-
-

Generic init

- -
-
-
-
-

Properties

- -
-

- balance -

-
-
public let balance: Decimal? 
-
-
-

The address XTZ balance in RPC format

- -
-
-
-

- type -

-
-
public let type: String
-
-
-

type of account e.g. "user" or "empty"

- -
-
-
-

- address -

-
-
public let address: String
-
-
-

tz1/2/3 kt1 address

- -
-
-
-

- public​Key -

-
-
public let publicKey: String? 
-
-
-

prefixed public key

- -
-
-
-

- revealed -

-
-
public let revealed: Bool? 
-
-
-

whether or not the account has performed a reveal operation

- -
-
-
-

- delegate -

-
-
public let delegate: TzKTAccountDelegate? 
-
-
-

The addresses delegation status

- -
-
-
-

- delegation​Level -

-
-
public let delegationLevel: Decimal? 
-
-
-

The block level the delegate address was set

- -
-
-
-

- active​Tokens​Count -

-
-
public let activeTokensCount: Decimal? 
-
-
-
-

- token​Balances​Count -

-
-
public let tokenBalancesCount: Decimal? 
-
-
-
-

- xtz​Balance -

-
-
public var xtzBalance: XTZAmount  
-
-
-

Helper method to convert the RPC balance into an XTZAmount

- -
-
-
- - - -
-
- - - - diff --git a/TzKTAccountDelegate/index.html b/TzKTAccountDelegate/index.html deleted file mode 100644 index c686d5cd..00000000 --- a/TzKTAccountDelegate/index.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTAccountDelegate - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTAccount​Delegate -

- -
-
public struct TzKTAccountDelegate: Codable, Equatable  
-
-
-

Model mapping to TzKT.io's Account.Delegate Object

- -
-
- -
- - - - - - -%769 - - - -TzKTAccountDelegate - - -TzKTAccountDelegate - - - - - -Equatable - -Equatable - - - -TzKTAccountDelegate->Equatable - - - - - -Codable - -Codable - - - -TzKTAccountDelegate->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Equatable
-
-
-
-

Initializers

- -
-

- init(alias:​address:​active:​) -

-
-
public init(alias: String?, address: String, active: Bool)  
-
-
-
-
-

Properties

- -
-

- alias -

-
-
public let alias: String? 
-
-
-

Bakers may have an alias (human readbale) name for their service

- -
-
-
-

- address -

-
-
public let address: String
-
-
-

Bakers must have a valid address

- -
-
-
-

- active -

-
-
public let active: Bool
-
-
-

Bool indicating whether or not the baker is currently active

- -
-
-
- - - -
-
- - - - diff --git a/TzKTAddress/index.html b/TzKTAddress/index.html deleted file mode 100644 index 588f2e01..00000000 --- a/TzKTAddress/index.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTAddress - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTAddress -

- -
-
public struct TzKTAddress: Codable  
-
-
-

Details about a given contract

- -
-
- -
- - - - - - -%643 - - - -TzKTAddress - - -TzKTAddress - - - - - -Codable - -Codable - - - -TzKTAddress->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(alias:​address:​) -

-
-
public init(alias: String?, address: String)  
-
-
-
-
-

Properties

- -
-

- alias -

-
-
public let alias: String? 
-
-
-

Contract addresses may have an alias (human readbale) name, to denote a person or service

- -
-
-
-

- address -

-
-
public let address: String
-
-
-

The KT1 address of the contract

- -
-
-
- - - -
-
- - - - diff --git a/TzKTBaker/index.html b/TzKTBaker/index.html deleted file mode 100644 index e632ed1f..00000000 --- a/TzKTBaker/index.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBaker - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBaker -

- -
-
public struct TzKTBaker: Codable, Hashable  
-
-
-

Data representing a baker from TzKT or Baking-Bad

- -
-
- -
- - - - - - -%211 - - - -TzKTBaker - - -TzKTBaker - - - - - -Codable - -Codable - - - -TzKTBaker->Codable - - - - - -Hashable - -Hashable - - - -TzKTBaker->Hashable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Hashable
-
-
-
-

Initializers

- -
-

- init(address:​name:​logo:​) -

-
-
public init(address: String, name: String?, logo: String?)  
-
-
-

Helper to create a TzKTBaker from the data available from the Account object

- -
-
-
-

- init(address:​name:​logo:​balance:​staking​Balance:​staking​Capacity:​max​Staking​Balance:​free​Space:​fee:​min​Delegation:​payout​Delay:​payout​Period:​open​For​Delegation:​estimated​Roi:​service​Health:​payout​Timing:​payout​Accuracy:​config:​) -

-
-
public init(address: String, name: String?, logo: String?, balance: Decimal, stakingBalance: Decimal, stakingCapacity: Decimal, maxStakingBalance: Decimal, freeSpace: Decimal, fee: Double, minDelegation: Decimal, payoutDelay: Int, payoutPeriod: Int, openForDelegation: Bool, estimatedRoi: Decimal, serviceHealth: TzKTBakerHealth, payoutTiming: TzKTBakerTiming, payoutAccuracy: TzKTBakerAccuracy, config: TzKTBakerConfig?)  
-
-
-
-
-

Properties

- -
-

- address -

-
-
public let address: String
-
-
-
-

- name -

-
-
public let name: String? 
-
-
- -
-

- balance -

-
-
public let balance: Decimal
-
-
-
-

- staking​Balance -

-
-
public let stakingBalance: Decimal
-
-
-
-

- staking​Capacity -

-
-
public let stakingCapacity: Decimal
-
-
-
-

- max​Staking​Balance -

-
-
public let maxStakingBalance: Decimal
-
-
-
-

- free​Space -

-
-
public let freeSpace: Decimal
-
-
-
-

- fee -

-
-
public let fee: Double
-
-
-
-

- min​Delegation -

-
-
public let minDelegation: Decimal
-
-
-
-

- payout​Delay -

-
-
public let payoutDelay: Int
-
-
-
-

- payout​Period -

-
-
public let payoutPeriod: Int
-
-
-
-

- open​For​Delegation -

-
-
public let openForDelegation: Bool
-
-
-
-

- estimated​Roi -

-
-
public let estimatedRoi: Decimal
-
-
-
-

- service​Health -

-
-
public let serviceHealth: TzKTBakerHealth
-
-
-
-

- payout​Timing -

-
-
public let payoutTiming: TzKTBakerTiming
-
-
-
-

- payout​Accuracy -

-
-
public let payoutAccuracy: TzKTBakerAccuracy
-
-
-
-

- config -

-
-
public let config: TzKTBakerConfig? 
-
-
-
-
-

Methods

- -
-

- from​Testnet​Array(_:​) -

-
-
public static func fromTestnetArray(_ data: [Any]) -> TzKTBaker?  
-
-
-

Ghostnet has a different setup for bakers, but we need to display and interact with them the same way. -So this helper extract what it can from the API and creates semi-real baker objects to help users deal with Ghostnet

- -
-
-
-

- reward​Struct() -

-
-
public func rewardStruct() -> TzKTBakerConfigRewardStruct?  
-
-
-

Convert con-chain data into a meaningful, readable object

- -
-
-
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: TzKTBaker, rhs: TzKTBaker) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/TzKTBakerAccuracy/index.html b/TzKTBakerAccuracy/index.html deleted file mode 100644 index 6a243ad6..00000000 --- a/TzKTBakerAccuracy/index.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBakerAccuracy - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - TzKTBaker​Accuracy -

- -
-
public enum TzKTBakerAccuracy: String, Codable  
-
-
-

The accuracy of the bakers payments

- -
-
- -
- - - - - - -%379 - - - -TzKTBakerAccuracy - - -TzKTBakerAccuracy - - - - - -Codable - -Codable - - - -TzKTBakerAccuracy->Codable - - - - - -String - -String - - - -TzKTBakerAccuracy->String - - - - - - - - -
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- precise -

-
-
case precise
-
-
-
-

- inaccurate -

-
-
case inaccurate
-
-
-
-

- suspicious -

-
-
case suspicious
-
-
-
-

- no_data -

-
-
case no_data
-
-
-
- - - -
-
- - - - diff --git a/TzKTBakerConfig/index.html b/TzKTBakerConfig/index.html deleted file mode 100644 index 4040de89..00000000 --- a/TzKTBakerConfig/index.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBakerConfig - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBaker​Config -

- -
-
public struct TzKTBakerConfig: Codable  
-
-
-

The bakers config file for details on when fees, min delegation etc change

- -
-
- -
- - - - - - -%31 - - - -TzKTBakerConfig - - -TzKTBakerConfig - - - - - -Codable - -Codable - - - -TzKTBakerConfig->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- address -

-
-
public let address: String
-
-
-
-

- fee -

-
-
public let fee: [TzKTBakerConfigDoubleValue] 
-
-
-
-

- min​Delegation -

-
-
public let minDelegation: [TzKTBakerConfigDoubleValue] 
-
-
-
-

- payout​Delay -

-
-
public let payoutDelay: [TzKTBakerConfigIntValue] 
-
-
-
-

- reward​Struct -

-
-
public let rewardStruct: [TzKTBakerConfigIntValue] 
-
-
-
-
-

Methods

- -
-

- lateset​Fee() -

-
-
public func latesetFee() -> Double  
-
-
-
-

- fee​For​Cycle(cycle:​) -

-
-
public func feeForCycle(cycle: Int) -> Double  
-
-
-
-

- latest​Payout​Delay() -

-
-
public func latestPayoutDelay() -> Int  
-
-
-
-

- payout​Delay​For​Cycle(cycle:​) -

-
-
public func payoutDelayForCycle(cycle: Int) -> Int  
-
-
-
-

- latest​Reward​Struct() -

-
-
public func latestRewardStruct() -> Int?  
-
-
-
- - - -
-
- - - - diff --git a/TzKTBakerConfigDoubleValue/index.html b/TzKTBakerConfigDoubleValue/index.html deleted file mode 100644 index 9d3560b4..00000000 --- a/TzKTBakerConfigDoubleValue/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBakerConfigDoubleValue - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBaker​Config​Double​Value -

- -
-
public struct TzKTBakerConfigDoubleValue: Codable  
-
-
- -
- - - - - - -%263 - - - -TzKTBakerConfigDoubleValue - - -TzKTBakerConfigDoubleValue - - - - - -Codable - -Codable - - - -TzKTBakerConfigDoubleValue->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- cycle -

-
-
public let cycle: Int
-
-
-
-

- value -

-
-
public let value: Double
-
-
-
- - - -
-
- - - - diff --git a/TzKTBakerConfigIntValue/index.html b/TzKTBakerConfigIntValue/index.html deleted file mode 100644 index 582a07c2..00000000 --- a/TzKTBakerConfigIntValue/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBakerConfigIntValue - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBaker​Config​Int​Value -

- -
-
public struct TzKTBakerConfigIntValue: Codable  
-
-
- -
- - - - - - -%451 - - - -TzKTBakerConfigIntValue - - -TzKTBakerConfigIntValue - - - - - -Codable - -Codable - - - -TzKTBakerConfigIntValue->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- cycle -

-
-
public let cycle: Int
-
-
-
-

- value -

-
-
public let value: Int
-
-
-
- - - -
-
- - - - diff --git a/TzKTBakerConfigRewardStruct/index.html b/TzKTBakerConfigRewardStruct/index.html deleted file mode 100644 index 5ec9e760..00000000 --- a/TzKTBakerConfigRewardStruct/index.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBakerConfigRewardStruct - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBaker​Config​Reward​Struct -

- -
-
public struct TzKTBakerConfigRewardStruct: Codable  
-
-
-

Baker config payout flags

- -
-
- -
- - - - - - -%375 - - - -TzKTBakerConfigRewardStruct - - -TzKTBakerConfigRewardStruct - - - - - -Codable - -Codable - - - -TzKTBakerConfigRewardStruct->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- blocks -

-
-
public let blocks: Bool
-
-
-
-

- missed​Blocks -

-
-
public let missedBlocks: Bool
-
-
-
-

- endorsements -

-
-
public let endorsements: Bool
-
-
-
-

- missed​Endorsements -

-
-
public let missedEndorsements: Bool
-
-
-
-

- fees -

-
-
public let fees: Bool
-
-
-
-

- missed​Fees -

-
-
public let missedFees: Bool
-
-
-
-

- accusation​Rewards -

-
-
public let accusationRewards: Bool
-
-
-
-

- accusation​Losses -

-
-
public let accusationLosses: Bool
-
-
-
-

- revelation​Rewards -

-
-
public let revelationRewards: Bool
-
-
-
-

- revelation​Losses -

-
-
public let revelationLosses: Bool
-
-
-
-
-

Methods

- -
-

- from​Config​Int(_:​) -

-
-
public static func fromConfigInt(_ config: Int) -> TzKTBakerConfigRewardStruct  
-
-
-

Convert the 14-bit number in the baker config, to the equivalent set of flags

- -
-
-
- - - -
-
- - - - diff --git a/TzKTBakerHealth/index.html b/TzKTBakerHealth/index.html deleted file mode 100644 index b249ffba..00000000 --- a/TzKTBakerHealth/index.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBakerHealth - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - TzKTBaker​Health -

- -
-
public enum TzKTBakerHealth: String, Codable  
-
-
-

The stability of the bakers server

- -
-
- -
- - - - - - -%445 - - - -TzKTBakerHealth - - -TzKTBakerHealth - - - - - -String - -String - - - -TzKTBakerHealth->String - - - - - -Codable - -Codable - - - -TzKTBakerHealth->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- active -

-
-
case active
-
-
-
-

- closed -

-
-
case closed
-
-
-
-

- dead -

-
-
case dead
-
-
-
- - - -
-
- - - - diff --git a/TzKTBakerTiming/index.html b/TzKTBakerTiming/index.html deleted file mode 100644 index efac5604..00000000 --- a/TzKTBakerTiming/index.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBakerTiming - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - TzKTBaker​Timing -

- -
-
public enum TzKTBakerTiming: String, Codable  
-
-
-

The reliability of the bakers payouts

- -
-
- -
- - - - - - -%747 - - - -TzKTBakerTiming - - -TzKTBakerTiming - - - - - -Codable - -Codable - - - -TzKTBakerTiming->Codable - - - - - -String - -String - - - -TzKTBakerTiming->String - - - - - - - - -
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- stable -

-
-
case stable
-
-
-
-

- unstable -

-
-
case unstable
-
-
-
-

- suspicious -

-
-
case suspicious
-
-
-
-

- no_data -

-
-
case no_data
-
-
-
- - - -
-
- - - - diff --git a/TzKTBalance/index.html b/TzKTBalance/index.html deleted file mode 100644 index f0fc117c..00000000 --- a/TzKTBalance/index.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBalance - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBalance -

- -
-
public struct TzKTBalance: Codable  
-
-
-

Model mapping to the Balance object returned from the new TzKT API, resulting from the merge of BCD and TzKT

- -
-
- -
- - - - - - -%545 - - - -TzKTBalance - - -TzKTBalance - - - - - -Codable - -Codable - - - -TzKTBalance->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- exception​List​NFT -

-
-
public static let exceptionListNFT = [
-		"KT1GBZmSxmnKJXGMdMLbugPfLyUPmuLSMwKS" // Tezos domains
-	] 
-
-
-
-

- balance -

-
-
public let balance: String
-
-
-

String containing the RPC respresetnation of the balance of the given token

- -
-
-
-

- token -

-
-
public let token: TzKTBalanceToken
-
-
-

Details about the Token

- -
-
-
-

- token​Amount -

-
-
public var tokenAmount: TokenAmount  
-
-
-

Helper to convert the RPC token balance to a TokenAmount object

- -
-
-
-
-

Methods

- -
-

- is​NFT() -

-
-
public func isNFT() -> Bool  
-
-
-

Basic check to see if token is an NFT or not. May not be 100% successful, needs research

- -
-
-
-

- is​OnNFTException​List() -

-
-
public func isOnNFTExceptionList() -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/TzKTBalanceMetadata/index.html b/TzKTBalanceMetadata/index.html deleted file mode 100644 index 9ee2c339..00000000 --- a/TzKTBalanceMetadata/index.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBalanceMetadata - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBalance​Metadata -

- -
-
public struct TzKTBalanceMetadata: Codable  
-
-
-

Metadata object for the token

- -
-
- -
- - - - - - -%397 - - - -TzKTBalanceMetadata - - -TzKTBalanceMetadata - - - - - -Codable - -Codable - - - -TzKTBalanceMetadata->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(name:​symbol:​decimals:​formats:​display​Uri:​artifact​Uri:​thumbnail​Uri:​description:​minting​Tool:​tags:​minter:​should​Prefer​Symbol:​attributes:​ttl:​) -

-
-
public init(name: String?, symbol: String?, decimals: String, formats: [TzKTBalanceMetadataFormat]?, displayUri: String?, artifactUri: String?, thumbnailUri: String?, description: String?, mintingTool: String?, tags: [String]?, minter: String?, shouldPreferSymbol: Bool?, attributes: [Any]?, ttl: Int?)  
-
-
-
-

- init(from:​) -

-
-
public init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- name -

-
-
public var name: String? 
-
-
-

A human readbale name

- -
-
-
-

- symbol -

-
-
public var symbol: String? 
-
-
-

The tokens symbol

- -
-
-
-

- decimals -

-
-
public var decimals: String
-
-
-

The number of decimals the token has

- -
-
-
-

- decimals​Int -

-
-
public var decimalsInt: Int  
-
-
-

Helper to convert the decimals to an Int

- -
-
-
-

- formats -

-
-
public var formats: [TzKTBalanceMetadataFormat]? 
-
-
-

Details of the available formats that the media is available in

- -
-
-
-

- display​Uri -

-
-
public var displayUri: String? 
-
-
-

URI to an medium/large image owned by the contract

- -
-
-
-

- artifact​Uri -

-
-
public var artifactUri: String? 
-
-
-

URI to the raw media artifact owned by the token

- -
-
-
-

- thumbnail​Uri -

-
-
public var thumbnailUri: String? 
-
-
-

URI to an small image for the token, ususally used as an icon when displayed in lists

- -
-
-
-

- description -

-
-
public var description: String? 
-
-
-

Description of the token or NFT

- -
-
-
-

- minting​Tool -

-
-
public var mintingTool: String? 
-
-
-

URL to the tool that was used to mint the item

- -
-
-
-

- tags -

-
-
public var tags: [String]? 
-
-
-

A list of tags to categorize the token / NFT

- -
-
-
-

- minter -

-
-
public var minter: String? 
-
-
-

The address responsible for creating the token / NFT

- -
-
-
-

- should​Prefer​Symbol -

-
-
public var shouldPreferSymbol: Bool? 
-
-
-

Whether or not the symbol or the name is prefered when displaying the token / NFT in a list

- -
-
-
-

- attributes -

-
-
public var attributes: [Any]? 
-
-
-

A collection of attributes about the token/NFT. Although TZIP-16 intended for this to be filled with info such as license, version, possible error messages etc, -It has been adopted by NFT creators as a more free-form dictionary. An example would be for gaming NFT's, this might be a list of attack/defensive moves the character is able to use -It is extremely likely that the actual type will be [[String: String]], however due to various issues and complexities of using a strongly typed language like Swift, -the easiest solution was to use [Any] with a custom decoder

- -
-
-
-

- ttl -

-
-
public let ttl: Int? 
-
-
-

Flag, in seconds, indicating how long to wait before refreshing the token to update its metadata. E.g. fxHash will inject a token with a name "[Waiting to be Signed]". and then, all things going well, 30 seconds later its updated to the correct attributes

- -
-
-
-

- thumbnail​URL -

-
-
public var thumbnailURL: URL?  
-
-
-

Helper to run the URI through the MediaProxyService to generate a useable URL for the thumbnail (if available)

- -
-
-
-

- display​URL -

-
-
public var displayURL: URL?  
-
-
-

Helper to run the URI through the MediaProxyService to generate a useable URL for the display image (if available)

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public func encode(to encoder: Encoder) throws  
-
-
-
-

- get​Key​Values​From​Attributes() -

-
-
public func getKeyValuesFromAttributes() -> [TzKTBalanceMetadataAttributeKeyValue]  
-
-
-

Attributes is a complex free-form object. In a lot of cases when NFT's are games / collectibles, it should be possible to convert most if not all the elements into more simple String: String key value pairs, which will be easier to manage in table / collection views

- -
-
-
- - - -
-
- - - - diff --git a/TzKTBalanceMetadataAttributeKeyValue/index.html b/TzKTBalanceMetadataAttributeKeyValue/index.html deleted file mode 100644 index 9a73279e..00000000 --- a/TzKTBalanceMetadataAttributeKeyValue/index.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBalanceMetadataAttributeKeyValue - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBalance​Metadata​Attribute​Key​Value -

- -
-
public struct TzKTBalanceMetadataAttributeKeyValue: Codable, Hashable  
-
-
-

Wrapper / Helper to extract metadata attribute content

- -
-
- -
- - - - - - -%731 - - - -TzKTBalanceMetadataAttributeKeyValue - - -TzKTBalanceMetadataAttributeKeyValue - - - - - -Hashable - -Hashable - - - -TzKTBalanceMetadataAttributeKeyValue->Hashable - - - - - -Codable - -Codable - - - -TzKTBalanceMetadataAttributeKeyValue->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Hashable
-
-
-
-

Initializers

- -
-

- init(key:​value:​) -

-
-
public init(key: String, value: String)  
-
-
-
-
-

Properties

- -
-

- key -

-
-
public let key: String
-
-
-
-

- value -

-
-
public let value: String
-
-
-
- - - -
-
- - - - diff --git a/TzKTBalanceMetadataDimensions/index.html b/TzKTBalanceMetadataDimensions/index.html deleted file mode 100644 index b633af3b..00000000 --- a/TzKTBalanceMetadataDimensions/index.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBalanceMetadataDimensions - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBalance​Metadata​Dimensions -

- -
-
public struct TzKTBalanceMetadataDimensions: Codable  
-
-
-

Object containing information about the dimensions of a given piece of media

- -
-
- -
- - - - - - -%513 - - - -TzKTBalanceMetadataDimensions - - -TzKTBalanceMetadataDimensions - - - - - -Codable - -Codable - - - -TzKTBalanceMetadataDimensions->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(unit:​value:​) -

-
-
public init(unit: String, value: String)  
-
-
-

Init to manaually create an instance, mostly for testing

- -
-
-
-
-

Properties

- -
-

- unit -

-
-
public let unit: String? 
-
-
-

The unit of measurement (e.g. px for pixels)

- -
-
-
-

- value -

-
-
public let value: String? 
-
-
-

String containing the resolution or size (e.g. 1024x787)

- -
-
-
- - - -
-
- - - - diff --git a/TzKTBalanceMetadataFormat/index.html b/TzKTBalanceMetadataFormat/index.html deleted file mode 100644 index e916e34d..00000000 --- a/TzKTBalanceMetadataFormat/index.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBalanceMetadataFormat - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBalance​Metadata​Format -

- -
-
public struct TzKTBalanceMetadataFormat: Codable  
-
-
-

Object containing information about the various formats the media is available in

- -
-
- -
- - - - - - -%393 - - - -TzKTBalanceMetadataFormat - - -TzKTBalanceMetadataFormat - - - - - -Codable - -Codable - - - -TzKTBalanceMetadataFormat->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(uri:​mime​Type:​dimensions:​) -

-
-
public init(uri: String, mimeType: String, dimensions: TzKTBalanceMetadataDimensions?)  
-
-
-

Init to manaually create an instance, mostly for testing

- -
-
-
-
-

Properties

- -
-

- uri -

-
-
public let uri: String
-
-
-

The URI to this specific format

- -
-
-
-

- mime​Type -

-
-
public let mimeType: String
-
-
-

The mimetype of this version

- -
-
-
-

- dimensions -

-
-
public let dimensions: TzKTBalanceMetadataDimensions? 
-
-
-

The display dimensions

- -
-
-
- - - -
-
- - - - diff --git a/TzKTBalanceToken/index.html b/TzKTBalanceToken/index.html deleted file mode 100644 index d9f13eaa..00000000 --- a/TzKTBalanceToken/index.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTBalanceToken - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTBalance​Token -

- -
-
public struct TzKTBalanceToken: Codable  
-
-
-

Model encapsulating information about the token itself

- -
-
- -
- - - - - - -%531 - - - -TzKTBalanceToken - - -TzKTBalanceToken - - - - - -Codable - -Codable - - - -TzKTBalanceToken->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Initializers

- -
-

- init(contract:​token​Id:​standard:​total​Supply:​metadata:​) -

-
-
public init(contract: TzKTAddress, tokenId: String, standard: FaVersion, totalSupply: String?, metadata: TzKTBalanceMetadata?)  
-
-
-
-

- init(from:​) -

-
-
public init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- contract -

-
-
public let contract: TzKTAddress
-
-
-

Details of the contract (e.g. address)

- -
-
-
-

- token​Id -

-
-
public let tokenId: String
-
-
-

The FA2 token ID of the token

- -
-
-
-

- standard -

-
-
public let standard: FaVersion
-
-
-

Which FA version the token conforms too

- -
-
-
-

- total​Supply -

-
-
public let totalSupply: String? 
-
-
-

Total avaialble supply of this address + token id combo

- -
-
-
-

- metadata -

-
-
public var metadata: TzKTBalanceMetadata? 
-
-
-

Metadata about the token

- -
-
-
-

- malformed​Metadata -

-
-
public var malformedMetadata: Bool
-
-
-
-

- display​Symbol -

-
-
public var displaySymbol: String  
-
-
-

Helper to determine what string is used as the symbol for display purposes

- -
-
-
-
-

Methods

- -
-

- encode(to:​) -

-
-
public func encode(to encoder: Encoder) throws  
-
-
-
- - - -
-
- - - - diff --git a/TzKTClient/index.html b/TzKTClient/index.html deleted file mode 100644 index 477cb8cc..00000000 --- a/TzKTClient/index.html +++ /dev/null @@ -1,756 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTClient - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - TzKTClient -

- -
-
public class TzKTClient  
-
-
-

TzKT is an indexer for Tezos, who's API allows developers to query details about wallets, transactions, bakers, account status etc

- -
-
- -
- - - - - - -%695 - - - -TzKTClient - - -TzKTClient - - - - - -HubConnectionDelegate - -HubConnectionDelegate - - - -TzKTClient->HubConnectionDelegate - - - - - - - - -
-

Nested Types

-
-
TzKTClient.TzKTServiceError
-

Unique Errors that TzKTClient can throw

-
-
TzKTClient.Constants
-

Constants needed for interacting with the API

-
-
-

Conforms To

-
-
HubConnectionDelegate
-
-
-
-

Initializers

- -
-

- init(network​Service:​config:​better​Call​Dev​Client:​dip​Dup​Client:​) -

-
-
public init(networkService: NetworkService, config: TezosNodeClientConfig, betterCallDevClient: BetterCallDevClient, dipDupClient: DipDupClient)  
-
-
-

Init a TzKTClient with a NetworkService and a TezosNodeClientConfig and a BetterCallDevClient.

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
network​ServiceNetwork​Service

NetworkService used to manage network communication.

-
configTezos​Node​Client​Config

TezosNodeClientConfig used to apss in settings.

-
better​Call​Dev​ClientBetter​Call​Dev​Client

BetterCallDevClient used to fetch more detailed errors about operation failures involving smart contracts.

-
dip​Dup​ClientDip​Dup​Client

DipDupClient used to fetch additional information about the tokens owned.

-
-
-
-
-

Properties

- -
-

- is​Listening -

-
-
public var isListening = false
-
-
-

Is currently monitoring an address for update notifications

- -
-
-
-

- account​Did​Change -

-
-
@Published public var accountDidChange: [String] = [] 
-
-
-

Notifications of monitored addresses that have changed

- -
-
-
-
-

Methods

- -
-

- get​Storage(for​Contract:​of​Type:​completion:​) -

-
-
public func getStorage<T: Codable>(forContract contract: String, ofType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void))  
-
-
-

Get the storage of a given contract and parse it to a supplied model type

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
for​ContractString

The KT1 contract address to query

-
of​TypeT.​Type

The Codable compliant model to parse the response as

-
completion@escaping ((Result<T, Kukai​Error>) -> Void)

A completion block called, returning a Swift Result type

-
-
-
-

- get​Big​Map(for​Id:​of​Type:​completion:​) -

-
-
public func getBigMap<T: Codable>(forId id: String, ofType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void))  
-
-
-

Get the keys of a big map, by ID and parse it to a model

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
for​IdString

The numeric ID of the big map

-
of​TypeT.​Type

The Codable compliant model to parse the response as

-
completion@escaping ((Result<T, Kukai​Error>) -> Void)

A completion block called, returning a Swift Result type

-
-
-
-

- get​Big​Map​Key(for​Id:​key:​of​Type:​completion:​) -

-
-
public func getBigMapKey<T: Codable>(forId id: String, key: String, ofType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void))  
-
-
-

Get the keys of a big map, but filtered to only one specific key. Parse the response as the supplied model

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
for​IdString

The numeric ID of the big map

-
keyString

The key to filter by

-
of​TypeT.​Type

The Codable compliant model to parse the response as

-
completion@escaping ((Result<T, Kukai​Error>) -> Void)

A completion block called, returning a Swift Result type

-
-
-
-

- suggest​Account(for​String:​completion:​) -

-
-
public func suggestAccount(forString: String, completion: @escaping ((Result<TzKTAddress?, KukaiError>) -> Void))  
-
-
-

Call https://api.tzkt.io/v1/suggest/accounts/... appending the supplied string, in an attempt to search for an account with a known alias

- -
-
-
-

- bakers(completion:​) -

-
-
public func bakers(completion: @escaping ((Result<[TzKTBaker], KukaiError>) -> Void))  
-
-
-

Call https://api.baking-bad.org/v2/bakers/ for a list of public bakers if on mainnet, else search for all accounts self delegating on testnet

- -
-
-
-

- baker​Config(for​Address:​completion:​) -

-
-
public func bakerConfig(forAddress: String, completion: @escaping ((Result<TzKTBaker, KukaiError>) -> Void))  
-
-
-

Call https://api.baking-bad.org/v2/bakers/...?configs=true to get the config settings for the given baker

- -
-
-
-

- delegator​Rewards(for​Address:​limit:​completion:​) -

-
-
public func delegatorRewards(forAddress: String, limit: Int = 25, completion: @escaping ((Result<[TzKTDelegatorReward], KukaiError>) -> Void))  
-
-
-

Call https://api.tzkt.io/v1/rewards/delegators/...?limit=... to get the config settings for the given baker

- -
-
-
-

- estimate​Last​And​Next​Reward(for​Address:​delegate:​completion:​) -

-
-
public func estimateLastAndNextReward(forAddress: String, delegate: TzKTAccountDelegate, completion: @escaping ((Result<AggregateRewardInformation, KukaiError>) -> Void))  
-
-
-

Make many different calls to attempt to figure out the previous reward the user should have received, and the next potential reward

- -
-
-
-

- get​Last​Reward(for​Address:​unique​Bakers:​payout​Addresses:​completion:​) -

-
-
public func getLastReward(forAddress: String, uniqueBakers: [TzKTAddress], payoutAddresses: [String: TzKTAddress], completion: @escaping ((Result<[TzKTTransaction], KukaiError>) -> Void))  
-
-
-

Take all the baker addresses and payout addresses and find the last transaction (if any) received from any of them

- -
-
-
-

- cycles(limit:​completion:​) -

-
-
public func cycles(limit: Int = 25, completion: @escaping ((Result<[TzKTCycle], KukaiError>) -> Void))  
-
-
-

Call https://api.tzkt.io/v1/cycles?limit=... to get the 10 most recent cycles

- -
-
-
-

- cycle​For​Level(cycles:​level:​) -

-
-
public func cycleForLevel(cycles: [TzKTCycle], level: Decimal) -> TzKTCycle?  
-
-
-

Given a list of cycles, search through them to find what cycle a given block level appeared in -If leveled supplied is less than the firstLevel of the last cycle, return the last

- -
-
-
-

- get​Operation(by​Hash:​completion:​) -

-
-
public func getOperation(byHash hash: String, completion: @escaping (([TzKTOperation]?, KukaiError?) -> Void))  
-
-
-

Query details about the given operation

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
by​HashString

The operation hash to query.

-
completion@escaping (([TzKTOperation]?, Kukai​Error?) -> Void)

A completion colsure called when the request is done.

-
-
-
-

- listen​For​Account​Changes(addresses:​with​Debugging:​) -

-
-
public func listenForAccountChanges(addresses: [String], withDebugging: Bool = false)  
-
-
-

Open a websocket connection to request a notification for any changes to the given account. The @Published var accountDidChange will be notified if something occurs

- -
-

Parameters

- - - - - - - - - - - - - - - - -
address

The Tz address of the account to monitor

-
-
-
-

- stop​Listening​For​Account​Changes() -

-
-
public func stopListeningForAccountChanges()  
-
-
-

Close the websocket from listenForAccountChanges

- -
-
-
-

- change​Address​ToListen​For​Changes(addresses:​) -

-
-
public func changeAddressToListenForChanges(addresses: [String])  
-
-
-

Close the current connection and open another

- -
-
-
-

- get​Balance​Count(for​Address:​completion:​) -

-
-
public func getBalanceCount(forAddress: String, completion: @escaping (Result<Int, KukaiError>) -> Void)  
-
-
-

Get the count of tokens the given address has balances for (excluding zero balances)

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
for​AddressString

The tz address to search for

-
completion@escaping (Result<Int, Kukai​Error>) -> Void

The completion block called with a Result containing the number or an error

-
-
-
-

- get​Balance​Page(for​Address:​offset:​completion:​) -

-
-
public func getBalancePage(forAddress: String, offset: Int = 0, completion: @escaping ((Result<[TzKTBalance], KukaiError>) -> Void))  
-
-
-

Tokens balances and metadata need to be fetch from a paginated API. THis function calls a sinlerequest or 1 page of balances / metadata

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
for​AddressString

The tz address to search for

-
offsetInt

The starting position

-
completion@escaping ((Result<[TzKTBalance], Kukai​Error>) -> Void)

The completion block called with a Result containing an array of balances or an error

-
-
-
-

- get​Account(for​Address:​completion:​) -

-
-
public func getAccount(forAddress: String, completion: @escaping ((Result<TzKTAccount, KukaiError>) -> Void))  
-
-
-

Get the account object from TzKT caontaining information about the address, its balance and baker

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
for​AddressString

The tz address to search for

-
completion@escaping ((Result<TzKTAccount, Kukai​Error>) -> Void)

The completion block called with a Result containing an object or an error

-
-
-
-

- get​All​Balances(for​Address:​completion:​) -

-
-
public func getAllBalances(forAddress address: String, completion: @escaping ((Result<Account, KukaiError>) -> Void))  
-
-
-

Get all balances from one function call, by fetching the result from getBalanceCount and using that to decide how many pages should be called

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
for​AddressString

The tz address to search for

-
completion@escaping ((Result<Account, Kukai​Error>) -> Void)

The completion block called with a Result containing an object or an error

-
-
-
-

- avatar​URL(for​Token:​) -

-
-
public static func avatarURL(forToken token: String) -> URL?  
-
-
-

In order to access the cached images, you need the URL it was downloaded from. This can either be found inside the Token objects returned as part of Account from the fetchAccountInfo func. -Or, if you need to use it seperately, given the token address you can use this function

- -
-

Parameters

- - - - - - - - - - - - - - - - -
for​TokenString

The token address who's image you are looking for.

-
-
-
-

- fetch​Transactions(for​Address:​limit:​completion:​) -

-
-
public func fetchTransactions(forAddress address: String, limit: Int = 50, completion: @escaping (([TzKTTransaction]) -> Void))  
-
-
-

Fetch all transactions, both account operations, and token transfers, and combine them into 1 response

- -
-
-
-

- group​Transactions(transactions:​current​Wallet​Address:​) -

-
-
public func groupTransactions(transactions: [TzKTTransaction], currentWalletAddress: String) -> [TzKTTransactionGroup]  
-
-
-

Group transactions into logical groups, so user doesn't see N enteries for 1 contract call resulting in many internal operations

- -
-
-
-

- connection​Did​Open(hub​Connection:​) -

-
-
public func connectionDidOpen(hubConnection: HubConnection)  
-
-
-
-

- connection​Did​Close(error:​) -

-
-
public func connectionDidClose(error: Error?)  
-
-
-
-

- connection​Did​Fail​ToOpen(error:​) -

-
-
public func connectionDidFailToOpen(error: Error)  
-
-
-
- - - -
-
- - - - diff --git a/TzKTClient_Constants/index.html b/TzKTClient_Constants/index.html deleted file mode 100644 index c14633bc..00000000 --- a/TzKTClient_Constants/index.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTClient.Constants - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTClient.​Constants -

- -
-
public struct Constants  
-
-
-

Constants needed for interacting with the API

- -
-
- - -

Member Of

-
-
TzKTClient
-

TzKT is an indexer for Tezos, who's API allows developers to query details about wallets, transactions, bakers, account status etc

-
-
-
-
-

Properties

- -
-

- token​Balance​Query​Size -

-
-
public static let tokenBalanceQuerySize = 10000
-
-
-
- - - -
-
- - - - diff --git a/TzKTClient_TzKTServiceError/index.html b/TzKTClient_TzKTServiceError/index.html deleted file mode 100644 index 52052381..00000000 --- a/TzKTClient_TzKTServiceError/index.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTClient.TzKTServiceError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - TzKTClient.​TzKTService​Error -

- -
-
public enum TzKTServiceError: Error  
-
-
-

Unique Errors that TzKTClient can throw

- -
-
- -
- - - - - - -%467 - - - -TzKTClient.TzKTServiceError - - -TzKTClient.TzKTServiceError - - - - - -Error - -Error - - - -TzKTClient.TzKTServiceError->Error - - - - - - - - -
-

Member Of

-
-
TzKTClient
-

TzKT is an indexer for Tezos, who's API allows developers to query details about wallets, transactions, bakers, account status etc

-
-
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- invalid​URL -

-
-
case invalidURL
-
-
-
-

- parse​Error -

-
-
case parseError(String) 
-
-
-
- - - -
-
- - - - diff --git a/TzKTCycle/index.html b/TzKTCycle/index.html deleted file mode 100644 index a4610b1f..00000000 --- a/TzKTCycle/index.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTCycle - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTCycle -

- -
-
public struct TzKTCycle: Codable  
-
-
-

The blockchain is broken down into cycles that last 2.7 days. Baker payment logic resolves around cycles instead of blocks

- -
-
- -
- - - - - - -%327 - - - -TzKTCycle - - -TzKTCycle - - - - - -Codable - -Codable - - - -TzKTCycle->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- index -

-
-
public let index: Int
-
-
-
-

- start​Time -

-
-
public let startTime: String
-
-
-
-

- first​Level -

-
-
public let firstLevel: Decimal
-
-
-
-

- end​Time -

-
-
public let endTime: String
-
-
-
-

- last​Level -

-
-
public let lastLevel: Decimal
-
-
-
-

- state​Date -

-
-
public var stateDate: Date?  
-
-
-
-

- end​Date -

-
-
public var endDate: Date?  
-
-
-
- - - -
-
- - - - diff --git a/TzKTDelegatorReward/index.html b/TzKTDelegatorReward/index.html deleted file mode 100644 index 7287fd94..00000000 --- a/TzKTDelegatorReward/index.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTDelegatorReward - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTDelegator​Reward -

- -
-
public struct TzKTDelegatorReward: Codable  
-
-
-

An object containing info on the reward a delegator should receive from a baker

- -
-
- -
- - - - - - -%363 - - - -TzKTDelegatorReward - - -TzKTDelegatorReward - - - - - -Codable - -Codable - - - -TzKTDelegatorReward->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- cycle -

-
-
public let cycle: Int
-
-
-
-

- balance -

-
-
public let balance: Decimal
-
-
-
-

- baker -

-
-
public let baker: TzKTAddress
-
-
-
-

- staking​Balance -

-
-
public let stakingBalance: Decimal
-
-
-
-

- block​Rewards -

-
-
public let blockRewards: Decimal
-
-
-
-

- missed​Block​Rewards -

-
-
public let missedBlockRewards: Decimal
-
-
-
-

- endorsement​Rewards -

-
-
public let endorsementRewards: Decimal
-
-
-
-

- missed​Endorsement​Rewards -

-
-
public let missedEndorsementRewards: Decimal
-
-
-
-

- block​Fees -

-
-
public let blockFees: Decimal
-
-
-
-

- missed​Block​Fees -

-
-
public let missedBlockFees: Decimal
-
-
-
-

- extra​Block​Rewards -

-
-
public let extraBlockRewards: Decimal
-
-
-
-

- missed​Extra​Block​Rewards -

-
-
public let missedExtraBlockRewards: Decimal
-
-
-
-

- future​Block​Rewards -

-
-
public let futureBlockRewards: Decimal
-
-
-
-

- future​Endorsement​Rewards -

-
-
public let futureEndorsementRewards: Decimal
-
-
-
-
-

Methods

- -
-

- estimated​Reward(with​Fee:​and​Reward​Struct:​) -

-
-
public func estimatedReward(withFee fee: Double, andRewardStruct: TzKTBakerConfigRewardStruct?) -> XTZAmount  
-
-
-

Return an estimated either for potential future or actual rewards

- -
-
-
- - - -
-
- - - - diff --git a/TzKTOperation/index.html b/TzKTOperation/index.html deleted file mode 100644 index 93b9730b..00000000 --- a/TzKTOperation/index.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTOperation - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTOperation -

- -
-
public struct TzKTOperation: Codable  
-
-
-

A model matching the response that comes back from TzKT's API: v1/operations/<operation-hash>

- -
-
- -
- - - - - - -%137 - - - -TzKTOperation - - -TzKTOperation - - - - - -Codable - -Codable - - - -TzKTOperation->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- type -

-
-
public let type: String
-
-
-

Type of operation (e.g. transaction, delegation, reveal etc)

- -
-
-
-

- id -

-
-
public let id: Int
-
-
-

Unique id to denote the operation

- -
-
-
-

- level -

-
-
public let level: Int
-
-
-

The block level it was injected at

- -
-
-
-

- timestamp -

-
-
public let timestamp: String
-
-
-

Timestamp it was injected at

- -
-
-
-

- block -

-
-
public let block: String
-
-
-

The hash of the injected block

- -
-
-
-

- hash -

-
-
public let hash: String
-
-
-

The operation hash

- -
-
-
-

- counter -

-
-
public let counter: Int
-
-
-

The users numerical counter of the operation

- -
-
-
-

- status -

-
-
public let status: String
-
-
-

Status of the operation (e.g. applied or failed)

- -
-
-
-

- errors -

-
-
public let errors: [TzKTOperationError]? 
-
-
-

Optional array of errors encountered while trying to inject the operation

- -
-
-
-
-

Methods

- -
-

- is​Failed() -

-
-
public func isFailed() -> Bool  
-
-
-

Helper to detect a failed transation by searching for a status of "failed", "backtracked" or "skipped"

- -
-
-
-

- contains​Error() -

-
-
public func containsError() -> Bool  
-
-
-

Helper to detect if this operation contains an error

- -
-
-
- - - -
-
- - - - diff --git a/TzKTOperationError/index.html b/TzKTOperationError/index.html deleted file mode 100644 index 6af98fbb..00000000 --- a/TzKTOperationError/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTOperationError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTOperation​Error -

- -
-
public struct TzKTOperationError: Codable  
-
-
-

TzKT's more basic error object response

- -
-
- -
- - - - - - -%207 - - - -TzKTOperationError - - -TzKTOperationError - - - - - -Codable - -Codable - - - -TzKTOperationError->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- type -

-
-
public let type: String
-
-
-

The RPC error type string

- -
-
-
- - - -
-
- - - - diff --git a/TzKTTokenTransfer/index.html b/TzKTTokenTransfer/index.html deleted file mode 100644 index 6c8982f3..00000000 --- a/TzKTTokenTransfer/index.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTTokenTransfer - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTToken​Transfer -

- -
-
public struct TzKTTokenTransfer: Codable  
-
-
-

FA1.2 / FA2 token transafers are treated differently from transactions. This object is used when fetching data form the API, as a temporary placeholder, ultimately to be merged into the transactions

- -
-
- -
- - - - - - -%351 - - - -TzKTTokenTransfer - - -TzKTTokenTransfer - - - - - -Codable - -Codable - - - -TzKTTokenTransfer->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
-
-
-

Properties

- -
-

- id -

-
-
public let id: Decimal
-
-
-
-

- hash -

-
-
public var hash: String?  
-
-
-
-

- level -

-
-
public let level: Decimal
-
-
-
-

- timestamp -

-
-
public let timestamp: String
-
-
-
-

- token -

-
-
public let token: TzKTBalanceToken
-
-
-
-

- to -

-
-
public let to: TzKTAddress? 
-
-
-
-

- from -

-
-
public let from: TzKTAddress? 
-
-
-
-

- amount -

-
-
public let amount: String
-
-
-
-

- transaction​Id -

-
-
public let transactionId: Decimal
-
-
-
-

- minting​Tool -

-
-
public let mintingTool: String? 
-
-
-
-
-

Methods

- -
-

- token​Amount() -

-
-
public func tokenAmount() -> TokenAmount  
-
-
-
- - - -
-
- - - - diff --git a/TzKTTransaction/index.html b/TzKTTransaction/index.html deleted file mode 100644 index 30043ed0..00000000 --- a/TzKTTransaction/index.html +++ /dev/null @@ -1,537 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTTransaction - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTTransaction -

- -
-
public struct TzKTTransaction: Codable, CustomStringConvertible, Hashable, Identifiable  
-
-
-

A model matching the response that comes back from TzKT's API: v1/accounts/<address>/operations

- -
-
- -
- - - - - - -%405 - - - -TzKTTransaction - - -TzKTTransaction - - - - - -Identifiable - -Identifiable - - - -TzKTTransaction->Identifiable - - - - - -Codable - -Codable - - - -TzKTTransaction->Codable - - - - - -CustomStringConvertible - -CustomStringConvertible - - - -TzKTTransaction->CustomStringConvertible - - - - - -Hashable - -Hashable - - - -TzKTTransaction->Hashable - - - - - - - - -
-

Nested Types

-
-
TzKTTransaction.TransactionStatus
-
-
TzKTTransaction.TransactionType
-
-
TzKTTransaction.TransactionSubType
-
-
TzKTTransaction.CodingKeys
-
-
-

Conforms To

-
-
Codable
-
CustomStringConvertible
-
Hashable
-
Identifiable
-
-
-
-

Initializers

- -
-

- init(type:​id:​level:​timestamp:​hash:​counter:​initiater:​sender:​baker​Fee:​storage​Fee:​allocation​Fee:​target:​prev​Delegate:​new​Delegate:​amount:​parameter:​status:​has​Internals:​token​Transfers​Count:​) -

-
-
public init(type: TransactionType, id: Decimal, level: Decimal, timestamp: String, hash: String, counter: Decimal, initiater: TzKTAddress?, sender: TzKTAddress, bakerFee: XTZAmount, storageFee: XTZAmount, allocationFee: XTZAmount, target: TzKTAddress?, prevDelegate: TzKTAddress?, newDelegate: TzKTAddress?, amount: TokenAmount, parameter: [String: String]?, status: TransactionStatus, hasInternals: Bool, tokenTransfersCount: Decimal?)  
-
-
-

Manually init a TzKTTransaction

- -
-
-
-

- init(from:​) -

-
-
public init(from: TzKTTokenTransfer)  
-
-
-

Convert a TzKTTokenTransfer into a TzKTTransaction

- -
-
-
-

- init(from:​) -

-
-
public init(from decoder: Decoder) throws  
-
-
-
-
-

Properties

- -
-

- date​Formatter -

-
-
public static let dateFormatter  
-
-
-
-

- type -

-
-
public let type: TransactionType
-
-
-
-

- id -

-
-
public let id: Decimal
-
-
-
-

- level -

-
-
public let level: Decimal
-
-
-
-

- timestamp -

-
-
public let timestamp: String
-
-
-
-

- hash -

-
-
public let hash: String
-
-
-
-

- counter -

-
-
public let counter: Decimal
-
-
-
-

- initiater -

-
-
public let initiater: TzKTAddress? 
-
-
-
-

- sender -

-
-
public let sender: TzKTAddress
-
-
-
-

- baker​Fee -

-
-
public var bakerFee: XTZAmount
-
-
-
-

- storage​Fee -

-
-
public var storageFee: XTZAmount
-
-
-
-

- allocation​Fee -

-
-
public var allocationFee: XTZAmount
-
-
-
-

- target -

-
-
public var target: TzKTAddress? 
-
-
-
-

- prev​Delegate -

-
-
public let prevDelegate: TzKTAddress? 
-
-
-
-

- new​Delegate -

-
-
public let newDelegate: TzKTAddress? 
-
-
-
-

- amount -

-
-
public var amount: TokenAmount
-
-
-
-

- parameter -

-
-
public let parameter: [String: String]? 
-
-
-
-

- status -

-
-
public let status: TransactionStatus
-
-
-
-

- has​Internals -

-
-
public let hasInternals: Bool
-
-
-
-

- token​Transfers​Count -

-
-
public let tokenTransfersCount: Decimal? 
-
-
-
-

- date -

-
-
public let date: Date? 
-
-
-
-

- tzkt​Token​Transfer -

-
-
public var tzktTokenTransfer: TzKTTokenTransfer? = nil  
-
-
-
-

- sub​Type -

-
-
public var subType: TransactionSubType? = nil
-
-
-
-

- entrypoint​Called -

-
-
public var entrypointCalled: String? = nil
-
-
-
-

- primary​Token -

-
-
public var primaryToken: Token? = nil
-
-
-
-

- description -

-
-
public var description: String  
-
-
-
-
-

Methods

- -
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-
-

- encode(to:​) -

-
-
public func encode(to encoder: Encoder) throws  
-
-
-
-

- placeholder(with​Status:​op​Hash:​type:​counter:​from​Wallet:​destination:​xtz​Amount:​parameters:​primary​Token:​) -

-
-
public static func placeholder(withStatus status: TransactionStatus, opHash: String, type: TransactionType, counter: Decimal, fromWallet: WalletMetadata, destination: TzKTAddress, xtzAmount: TokenAmount, parameters: [String: String]?, primaryToken: Token?) -> TzKTTransaction  
-
-
-

Used for creating "Pending" transactions

- -
-
-
-

- placeholder(with​Status:​op​Hash:​type:​counter:​from​Wallet:​new​Delegate:​) -

-
-
public static func placeholder(withStatus status: TransactionStatus, opHash: String, type: TransactionType, counter: Decimal, fromWallet: WalletMetadata, newDelegate: TzKTAddress?) -> TzKTTransaction  
-
-
-

Used for createing a "Pending" delegation transaction

- -
-
-
-

- parameter​Value​AsArray() -

-
-
public func parameterValueAsArray() -> [Any]?  
-
-
-
-

- parameter​Value​AsDict() -

-
-
public func parameterValueAsDict() -> [String: Any]?  
-
-
-
-

- parameter​Value​AsArray​OfDictionary() -

-
-
public func parameterValueAsArrayOfDictionary() -> [[String: Any]]?  
-
-
-
-

- parameter​Value​AsType(type:​) -

-
-
public func parameterValueAsType<T>(type: T.Type) -> T?  
-
-
-
-

- get​Entrypoint() -

-
-
public func getEntrypoint() -> String?  
-
-
-
-

- process​Additional​Data(with​Current​Wallet​Address:​) -

-
-
public mutating func processAdditionalData(withCurrentWalletAddress currentWalletAddress: String)  
-
-
-
-

- create​Primary​Token() -

-
-
public func createPrimaryToken() -> Token?  
-
-
-
-

- get​FaToken​Transfer​Data() -

-
-
public func getFaTokenTransferData() -> Token?  
-
-
-

The TzKT transaction API doesn't provide all the info needed to normalise Token amounts. It only gives address and rpc amount. -Burried inside the michelson, the dex contract needs to be told the token id, and the target will contain the address. -This function will try to extract address, token id and rpc amount and return them in the standard objects, so that they can be used in conjuction with other functions to fetch the decimal data. -e.g. DipDup client can fetch all tokens from dexes, containing all token info. Using the address and id, the rest could be found via that, assuming zero for anything else (such as NFTs)

- -
-
-
-

- get​Token​Transfer​Destination() -

-
-
public func getTokenTransferDestination() -> String?  
-
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: TzKTTransaction, rhs: TzKTTransaction) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/TzKTTransactionGroup/index.html b/TzKTTransactionGroup/index.html deleted file mode 100644 index 92daa5ab..00000000 --- a/TzKTTransactionGroup/index.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTTransactionGroup - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - TzKTTransaction​Group -

- -
-
public struct TzKTTransactionGroup: Codable, Hashable, Identifiable, CustomStringConvertible  
-
-
-

Artifical object used to group related transactions into a more user friendly display -For example, 1 contract call can reuslt in many transactions being returned. To avoid the users UI being clogged, we group all them into 1 group, so the user only needs to see 1 item for 1 action they performed

- -
-
- -
- - - - - - -%127 - - - -TzKTTransactionGroup - - -TzKTTransactionGroup - - - - - -CustomStringConvertible - -CustomStringConvertible - - - -TzKTTransactionGroup->CustomStringConvertible - - - - - -Hashable - -Hashable - - - -TzKTTransactionGroup->Hashable - - - - - -Identifiable - -Identifiable - - - -TzKTTransactionGroup->Identifiable - - - - - -Codable - -Codable - - - -TzKTTransactionGroup->Codable - - - - - - - - -
-

Conforms To

-
-
Codable
-
CustomStringConvertible
-
Hashable
-
Identifiable
-
-
-
-

Initializers

- -
-

- init?(with​Transactions:​current​Wallet​Address:​) -

-
-
public init?(withTransactions transactions: [TzKTTransaction], currentWalletAddress: String)  
-
-
-
-
-

Properties

- -
-

- group​Type -

-
-
public var groupType: TzKTTransaction.TransactionSubType
-
-
-
-

- hash -

-
-
public let hash: String
-
-
-
-

- transactions -

-
-
public let transactions: [TzKTTransaction] 
-
-
-
-

- primary​Token -

-
-
public var primaryToken: Token? = nil
-
-
-
-

- secondary​Token -

-
-
public var secondaryToken: Token? = nil
-
-
-
-

- entrypoint​Called -

-
-
public var entrypointCalled: String? = nil
-
-
-
-

- id -

-
-
public var id: Decimal  
-
-
-
-

- description -

-
-
public var description: String  
-
-
-
-
-

Methods

- -
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: TzKTTransactionGroup, rhs: TzKTTransactionGroup) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/TzKTTransaction_CodingKeys/index.html b/TzKTTransaction_CodingKeys/index.html deleted file mode 100644 index 8c02dd58..00000000 --- a/TzKTTransaction_CodingKeys/index.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTTransaction.CodingKeys - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - TzKTTransaction.​Coding​Keys -

- -
-
public enum CodingKeys: String, CodingKey  
-
-
- -
- - - - - - -%725 - - - -TzKTTransaction.CodingKeys - - -TzKTTransaction.CodingKeys - - - - - -String - -String - - - -TzKTTransaction.CodingKeys->String - - - - - -CodingKey - -CodingKey - - - -TzKTTransaction.CodingKeys->CodingKey - - - - - - - - -
-

Member Of

-
-
TzKTTransaction
-

A model matching the response that comes back from TzKT's API: v1/accounts/<address>/operations

-
-
-

Conforms To

-
-
CodingKey
-
String
-
-
-
-

Enumeration Cases

- -
-

- id -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- storage​Fee -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- initiater -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- new​Delegate -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- has​Internals -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- prev​Delegate -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- target -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- timestamp -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- level -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- primary​Token -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- parameter -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- sender -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- baker​Fee -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- token​Transfers​Count -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- counter -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- sub​Type -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- amount -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- type -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- allocation​Fee -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- hash -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- entrypoint​Called -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
-

- status -

-
-
case type, id, level, timestamp, hash, counter, initiater, sender, bakerFee, storageFee, allocationFee, target, prevDelegate, newDelegate, amount, parameter, status, subType, entrypointCalled, primaryToken, hasInternals, tokenTransfersCount
-
-
-
- - - -
-
- - - - diff --git a/TzKTTransaction_TransactionStatus/index.html b/TzKTTransaction_TransactionStatus/index.html deleted file mode 100644 index 7bc27e31..00000000 --- a/TzKTTransaction_TransactionStatus/index.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTTransaction.TransactionStatus - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - TzKTTransaction.​Transaction​Status -

- -
-
public enum TransactionStatus: String, Codable  
-
-
- -
- - - - - - -%563 - - - -TzKTTransaction.TransactionStatus - - -TzKTTransaction.TransactionStatus - - - - - -Codable - -Codable - - - -TzKTTransaction.TransactionStatus->Codable - - - - - -String - -String - - - -TzKTTransaction.TransactionStatus->String - - - - - - - - -
-

Member Of

-
-
TzKTTransaction
-

A model matching the response that comes back from TzKT's API: v1/accounts/<address>/operations

-
-
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- applied -

-
-
case applied
-
-
-
-

- failed -

-
-
case failed
-
-
-
-

- backtracked -

-
-
case backtracked
-
-
-
-

- unconfirmed -

-
-
case unconfirmed
-
-
-
-

- partially​Confirmed -

-
-
case partiallyConfirmed
-
-
-
-

- confirmed -

-
-
case confirmed
-
-
-
-

- unknown -

-
-
case unknown
-
-
-
- - - -
-
- - - - diff --git a/TzKTTransaction_TransactionSubType/index.html b/TzKTTransaction_TransactionSubType/index.html deleted file mode 100644 index 3299ac61..00000000 --- a/TzKTTransaction_TransactionSubType/index.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTTransaction.TransactionSubType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - TzKTTransaction.​Transaction​Sub​Type -

- -
-
public enum TransactionSubType: String, Codable  
-
-
- -
- - - - - - -%753 - - - -TzKTTransaction.TransactionSubType - - -TzKTTransaction.TransactionSubType - - - - - -String - -String - - - -TzKTTransaction.TransactionSubType->String - - - - - -Codable - -Codable - - - -TzKTTransaction.TransactionSubType->Codable - - - - - - - - -
-

Member Of

-
-
TzKTTransaction
-

A model matching the response that comes back from TzKT's API: v1/accounts/<address>/operations

-
-
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- send -

-
-
case send
-
-
-
-

- receive -

-
-
case receive
-
-
-
-

- delegate -

-
-
case delegate
-
-
-
-

- reveal -

-
-
case reveal
-
-
-
-

- exchange -

-
-
case exchange
-
-
-
-

- contract​Call -

-
-
case contractCall
-
-
-
-

- unknown -

-
-
case unknown
-
-
-
- - - -
-
- - - - diff --git a/TzKTTransaction_TransactionType/index.html b/TzKTTransaction_TransactionType/index.html deleted file mode 100644 index 8587cb3e..00000000 --- a/TzKTTransaction_TransactionType/index.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - KukaiCoreSwift - TzKTTransaction.TransactionType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - TzKTTransaction.​Transaction​Type -

- -
-
public enum TransactionType: String, Codable  
-
-
- -
- - - - - - -%141 - - - -TzKTTransaction.TransactionType - - -TzKTTransaction.TransactionType - - - - - -Codable - -Codable - - - -TzKTTransaction.TransactionType->Codable - - - - - -String - -String - - - -TzKTTransaction.TransactionType->String - - - - - - - - -
-

Member Of

-
-
TzKTTransaction
-

A model matching the response that comes back from TzKT's API: v1/accounts/<address>/operations

-
-
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- delegation -

-
-
case delegation
-
-
-
-

- origination -

-
-
case origination
-
-
-
-

- transaction -

-
-
case transaction
-
-
-
-

- reveal -

-
-
case reveal
-
-
-
-

- unknown -

-
-
case unknown
-
-
-
- - - -
-
- - - - diff --git a/UIImage/index.html b/UIImage/index.html deleted file mode 100644 index f41d4180..00000000 --- a/UIImage/index.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - KukaiCoreSwift - UIImage - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Typealias - UIImage -

- -
-
public typealias UIImage = NSImage
-
-
-

Create "UIImage" as typealias of NSImage

- -
-
-
- - - - diff --git a/Wallet/index.html b/Wallet/index.html deleted file mode 100644 index e4244dd6..00000000 --- a/Wallet/index.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - KukaiCoreSwift - Wallet - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Protocol - Wallet -

- -
-
public protocol Wallet: Codable  
-
-
-

Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

- -
-
- -
- - - - - - -%15 - - - -Wallet - - -Wallet - - - - - -Codable - -Codable - - - -Wallet->Codable - - - - - -LedgerWallet - - -LedgerWallet - - - - - -LedgerWallet->Wallet - - - - - -HDWallet - - -HDWallet - - - - - -HDWallet->Wallet - - - - - -RegularWallet - - -RegularWallet - - - - - -RegularWallet->Wallet - - - - - - - - -
-

Conforms To

-
-
Codable
-
-

Types Conforming to Wallet

-
-
HDWallet
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

-
-
LedgerWallet
-

A Tezos wallet class, used to cache infomration regarding the paired ledger device used to sign the payload. -This class can only be created by fetching data from a Ledger device and supplying this data to the constructor.

-
-
RegularWallet
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

-
-
-
- - - -
-

Requirements

- -
-

- type -

-
-
var type: WalletType  
-
-
-

Which underlying WalletType is the wallet using

- -
-
-
-

- address -

-
-
var address: String  
-
-
-

The public TZ1 or TZ2 address of the wallet

- -
-
-
-

- sign(_:​is​Operation:​completion:​) -

-
-
func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void)) 
-
-
-

Sign a hex string with the wallets private key

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
hexString

A hex encoded string, representing a forged operation payload.

-
completion@escaping ((Result<[UInt8], Kukai​Error>) -> Void)

A completion block to run with the resulting signature, needs to be done async in order to support usecases such as signing with an external ledger.

-
-
-
-

- private​Key​Curve() -

-
-
func privateKeyCurve() -> EllipticalCurve
-
-
-

Query which curve the given wallet is using

- -
-
-
-

- public​Key​Base58encoded() -

-
-
func publicKeyBase58encoded() -> String
-
-
-

Base58 encoded version of the publicKey, used when performing a reveal operation

- -
-
-
-
-
- - - - diff --git a/WalletCacheService/index.html b/WalletCacheService/index.html deleted file mode 100644 index 7abfb4b2..00000000 --- a/WalletCacheService/index.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - KukaiCoreSwift - WalletCacheService - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - Wallet​Cache​Service -

- -
-
public class WalletCacheService  
-
-
-

A service class used to store and retrieve Wallet objects such as RegularWallet, HDWallet, LedgerWallet and TorusWallet from the devices disk. -This class will use the secure enclave (keychain if not available) to generate a key used to encrypt the contents locally, and retrieve. -This class will also store non senstiivve "metadata" about wallets, to allow storage of UI related data users might want to add, without cluttering up the wallet objects themselves

- -
- -
-

Initializers

- -
-

- init() -

-
-
public init()  
-
-
-

Empty

- -
-
-
-
-

Methods

- -
-

- cache(wallet:​child​OfIndex:​backed​Up:​) -

-
-
public func cache<T: Wallet>(wallet: T, childOfIndex: Int?, backedUp: Bool) -> Bool  
-
-
-

Securely cache a walelt object, and record a default metadata object

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
walletT

An object conforming to Wallet to be stored

-
child​OfIndexInt?

An optional Int to denote the index of the HD wallet that this wallet is a child of

-
-

Returns

-

Bool, indicating if the storage was successful or not

- -
-
-

- cache​Watch​Wallet(metadata:​) -

-
-
public func cacheWatchWallet(metadata: WalletMetadata) -> Bool  
-
-
-

Cahce a watch wallet metadata obj, only. Metadata cahcing handled via wallet cache method

- -
-
-
-

- delete​Wallet(with​Address:​parent​Index:​) -

-
-
public func deleteWallet(withAddress: String, parentIndex: Int?) -> Bool  
-
-
-

Delete both a secure wallet entry and its related metadata object

- -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - -
with​AddressString

The address of the wallet

-
parent​IndexInt?

An optional Int to denote the index of the HD wallet that this wallet is a child of

-
-

Returns

-

Bool, indicating if the storage was successful or not

- -
-
-

- delete​Watch​Wallet(address:​) -

-
-
public func deleteWatchWallet(address: String) -> Bool  
-
-
-

Clear a watch wallet meatadata obj from the metadata cache only, does not affect actual wallet cache

- -
-
-
-

- fetch​Wallet(for​Address:​) -

-
-
public func fetchWallet(forAddress address: String) -> Wallet?  
-
-
-

Find and return the secure object for a given address

- -
-

Returns

-

Optional object confirming to Wallet protocol

- -
-
-

- delete​All​Cache​And​Keys() -

-
-
public func deleteAllCacheAndKeys() -> Bool  
-
-
-

Delete the cached files and the assoicate keys used to encrypt it

- -
-

Returns

-

Bool, indicating if the process was successful or not

- -
-
-

- encrypt​And​Write​ToDisk(wallets:​) -

-
-
public func encryptAndWriteToDisk(wallets: [String: Wallet]) -> Bool  
-
-
-

Take a dictionary of Wallet objects with their addresses as the key, serialise to JSON, encrypt and then write to disk

- -
-

Returns

-

Bool, indicating if the process was successful

- -
-
-

- read​From​Disk​And​Decrypt() -

-
-
public func readFromDiskAndDecrypt() -> [String: Wallet]?  
-
-
-

Go to the file on disk (if present), decrypt its contents and retrieve a dictionary of `Wallet's with the key being the wallet address

- -
-

Returns

-

A dictionary of Wallet if present on disk

- -
-
-

- write​Nonsensitive(_:​) -

-
-
public func writeNonsensitive(_ metadata: WalletMetadataList) -> Bool  
-
-
-

Write an ordered array of WalletMetadata to disk, replacing existing file if exists

- -
-
-
-

- read​Nonsensitive() -

-
-
public func readNonsensitive() -> WalletMetadataList  
-
-
-

Return an ordered array of WalletMetadata if present on disk

- -
-
-
-

- load​OrCreate​Keys() -

-
-
public func loadOrCreateKeys() -> Bool  
-
-
-

Load the key references from the secure enclave (or keychain), or create them if non exist

- -
-

Returns

-

Bool, indicating if operation was successful

- -
-
-

- unload​Keys() -

-
-
public func unloadKeys()  
-
-
-

Clear the key refrences

- -
-
-
-

- delete​Key() -

-
-
public func deleteKey() throws  
-
-
-

Delete a key from the secure enclave

- -
-
-
-

- encrypt(_:​) -

-
-
public func encrypt(_ string: String) throws -> Data  
-
-
-

Encrypts string using the Secure Enclave

- -
-

Parameters

- - - - - - - - - - - - - - - - -
stringString

clear text to be encrypted

-
-

Throws

-

CryptoKit error

- -

Returns

-

cipherText encrypted string

- -
-
-

- decrypt(_:​) -

-
-
public func decrypt(_ cipherText: Data) throws -> String  
-
-
-

Decrypts cipher text using the Secure Enclave

- -
-

Parameters

- - - - - - - - - - - - - - - - -
cipher​TextData

encrypted cipher text

-
-

Throws

-

CryptoKit error

- -

Returns

-

cleartext string

- -
-
- - - -
-
- - - - diff --git a/WalletError/index.html b/WalletError/index.html deleted file mode 100644 index aaa6813f..00000000 --- a/WalletError/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - KukaiCoreSwift - WalletError - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Wallet​Error -

- -
-
public enum WalletError: Error  
-
-
-

Possible error types that can occur when using the LedgerWallet

- -
-
- -
- - - - - - -%687 - - - -WalletError - - -WalletError - - - - - -Error - -Error - - - -WalletError->Error - - - - - - - - -
-

Conforms To

-
-
Error
-
-
-
-

Enumeration Cases

- -
-

- signature​Error -

-
-
case signatureError
-
-
-
- - - -
-
- - - - diff --git a/WalletMetadata/index.html b/WalletMetadata/index.html deleted file mode 100644 index 2045a04f..00000000 --- a/WalletMetadata/index.html +++ /dev/null @@ -1,309 +0,0 @@ - - - - - - KukaiCoreSwift - WalletMetadata - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Wallet​Metadata -

- -
-
public struct WalletMetadata: Codable, Hashable  
-
-
-

Object to store UI related info about wallets, seperated from the wallet object itself to avoid issues merging together

- -
-
- -
- - - - - - -%521 - - - -WalletMetadata - - -WalletMetadata - - - - - -Codable - -Codable - - - -WalletMetadata->Codable - - - - - -Hashable - -Hashable - - - -WalletMetadata->Hashable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Hashable
-
-
-
-

Initializers

- -
-

- init(address:​hd​Wallet​Group​Name:​wallet​Nickname:​social​Username:​mainnet​Domains:​ghostnet​Domains:​social​Type:​type:​children:​is​Child:​is​Watch​Only:​bas58Encoded​Public​Key:​backed​Up:​) -

-
-
public init(address: String, hdWalletGroupName: String?, walletNickname: String? = nil, socialUsername: String? = nil, mainnetDomains: [TezosDomainsReverseRecord]? = nil, ghostnetDomains: [TezosDomainsReverseRecord]? = nil, socialType: TorusAuthProvider? = nil, type: WalletType, children: [WalletMetadata], isChild: Bool, isWatchOnly: Bool, bas58EncodedPublicKey: String, backedUp: Bool)  
-
-
-
-
-

Properties

- -
-

- address -

-
-
public var address: String
-
-
-
-

- hd​Wallet​Group​Name -

-
-
public var hdWalletGroupName: String? 
-
-
-
-

- wallet​Nickname -

-
-
public var walletNickname: String? 
-
-
-
-

- social​Username -

-
-
public var socialUsername: String? 
-
-
-
-

- mainnet​Domains -

-
-
public var mainnetDomains: [TezosDomainsReverseRecord]? 
-
-
-
-

- ghostnet​Domains -

-
-
public var ghostnetDomains: [TezosDomainsReverseRecord]? 
-
-
-
-

- social​Type -

-
-
public var socialType: TorusAuthProvider? 
-
-
-
-

- type -

-
-
public var type: WalletType
-
-
-
-

- children -

-
-
public var children: [WalletMetadata] 
-
-
-
-

- is​Child -

-
-
public var isChild: Bool
-
-
-
-

- is​Watch​Only -

-
-
public var isWatchOnly: Bool
-
-
-
-

- bas58Encoded​Public​Key -

-
-
public var bas58EncodedPublicKey: String
-
-
-
-

- backed​Up -

-
-
public var backedUp: Bool
-
-
-
-
-

Methods

- -
-

- has​Mainnet​Domain() -

-
-
public func hasMainnetDomain() -> Bool  
-
-
-
-

- has​Ghostnet​Domain() -

-
-
public func hasGhostnetDomain() -> Bool  
-
-
-
-

- has​Domain(on​Network:​) -

-
-
public func hasDomain(onNetwork network: TezosNodeClientConfig.NetworkType) -> Bool  
-
-
-
-

- primary​Mainnet​Domain() -

-
-
public func primaryMainnetDomain() -> TezosDomainsReverseRecord?  
-
-
-
-

- primary​Ghostnet​Domain() -

-
-
public func primaryGhostnetDomain() -> TezosDomainsReverseRecord?  
-
-
-
-

- primary​Domain(on​Network:​) -

-
-
public func primaryDomain(onNetwork network: TezosNodeClientConfig.NetworkType) -> TezosDomainsReverseRecord?  
-
-
-
-

- hash(into:​) -

-
-
public func hash(into hasher: inout Hasher)  
-
-
-
-
-

Operators

- -
-

- == -

-
-
public static func == (lhs: WalletMetadata, rhs: WalletMetadata) -> Bool  
-
-
-
- - - -
-
- - - - diff --git a/WalletMetadataList/index.html b/WalletMetadataList/index.html deleted file mode 100644 index 6740174a..00000000 --- a/WalletMetadataList/index.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - - KukaiCoreSwift - WalletMetadataList - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Structure - Wallet​Metadata​List -

- -
-
public struct WalletMetadataList: Codable, Hashable  
-
-
-

Container to store groups of WalletMetadata based on type

- -
-
- -
- - - - - - -%599 - - - -WalletMetadataList - - -WalletMetadataList - - - - - -Codable - -Codable - - - -WalletMetadataList->Codable - - - - - -Hashable - -Hashable - - - -WalletMetadataList->Hashable - - - - - - - - -
-

Conforms To

-
-
Codable
-
Hashable
-
-
-
-

Initializers

- -
-

- init(social​Wallets:​hd​Wallets:​linear​Wallets:​ledger​Wallets:​watch​Wallets:​) -

-
-
public init(socialWallets: [WalletMetadata], hdWallets: [WalletMetadata], linearWallets: [WalletMetadata], ledgerWallets: [WalletMetadata], watchWallets: [WalletMetadata])  
-
-
-
-
-

Properties

- -
-

- social​Wallets -

-
-
public var socialWallets: [WalletMetadata] 
-
-
-
-

- hd​Wallets -

-
-
public var hdWallets: [WalletMetadata] 
-
-
-
-

- linear​Wallets -

-
-
public var linearWallets: [WalletMetadata] 
-
-
-
-

- ledger​Wallets -

-
-
public var ledgerWallets: [WalletMetadata] 
-
-
-
-

- watch​Wallets -

-
-
public var watchWallets: [WalletMetadata] 
-
-
-
-
-

Methods

- -
-

- is​Empty() -

-
-
public func isEmpty() -> Bool  
-
-
-
-

- first​Metadata() -

-
-
public func firstMetadata() -> WalletMetadata?  
-
-
-
-

- metadata(for​Address:​) -

-
-
public func metadata(forAddress address: String) -> WalletMetadata?  
-
-
-
-

- update(address:​with:​) -

-
-
public mutating func update(address: String, with newMetadata: WalletMetadata) -> Bool  
-
-
-
-

- set(mainnet​Domain:​ghostnet​Domain:​for​Address:​) -

-
-
public mutating func set(mainnetDomain: TezosDomainsReverseRecord?, ghostnetDomain: TezosDomainsReverseRecord?, forAddress address: String) -> Bool  
-
-
-
-

- set(nickname:​for​Address:​) -

-
-
public mutating func set(nickname: String?, forAddress address: String) -> Bool  
-
-
-
-

- set(hd​Wallet​Group​Name:​for​Address:​) -

-
-
public mutating func set(hdWalletGroupName: String, forAddress address: String) -> Bool  
-
-
-
-

- count() -

-
-
public func count() -> Int  
-
-
-
-

- addresses() -

-
-
public func addresses() -> [String]  
-
-
-
-

- all​Metadata(only​Seed​Based:​) -

-
-
public func allMetadata(onlySeedBased: Bool = false) -> [WalletMetadata]  
-
-
-
- - - -
-
- - - - diff --git a/WalletType/index.html b/WalletType/index.html deleted file mode 100644 index 9574aa2b..00000000 --- a/WalletType/index.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - KukaiCoreSwift - WalletType - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Enumeration - Wallet​Type -

- -
-
public enum WalletType: String, Codable  
-
-
-

Enum to distingush between linear (non-hd) wallets, using the Bip39 standard, and hd wallets using the Bip44 standard.

- -
-
- -
- - - - - - -%163 - - - -WalletType - - -WalletType - - - - - -Codable - -Codable - - - -WalletType->Codable - - - - - -String - -String - - - -WalletType->String - - - - - - - - -
-

Conforms To

-
-
Codable
-
String
-
-
-
-

Enumeration Cases

- -
-

- regular -

-
-
case regular
-
-
-
-

- hd -

-
-
case hd
-
-
-
-

- social -

-
-
case social
-
-
-
-

- ledger -

-
-
case ledger
-
-
-
- - - -
-
- - - - diff --git a/XTZAmount/index.html b/XTZAmount/index.html deleted file mode 100644 index a3267447..00000000 --- a/XTZAmount/index.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - KukaiCoreSwift - XTZAmount - - - -
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-

- Class - XTZAmount -

- -
-
public class XTZAmount: TokenAmount  
-
-
-

A subclass of TokenAmount to make it more explict when functions require XTZ (such as network fees). -It also serves as a means to more quickly create TokenAmount's conforming to XTZ.

- -
-
- -
- - - - - - -%243 - - - -XTZAmount - - -XTZAmount - - - - - -TokenAmount - - -TokenAmount - - - - - -XTZAmount->TokenAmount - - - - - - - - -
-

Superclass

-
-
TokenAmount
-

Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length. -This class is used to encapsulate a BigInt and provide all the necessary init's and formatting functions to work with the networks requirements.

-
-
-
-
-

Initializers

- -
-

- init?(from​Rpc​Amount:​) -

-
-
public init?(fromRpcAmount rpcAmount: String)  
-
-
-

Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. "1 XTZ" to the user = "1000000" to the RPC, as there are no such thing as decimal places on the network

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​Rpc​AmountString

A string conforming to the RPC standard for XTZ.

-
-
-
-

- init?(from​Rpc​Amount:​) -

-
-
public convenience init?(fromRpcAmount rpcAmount: Decimal)  
-
-
-

Set the internal balance, using a decimal version of an RPC amount. e.g. "1 XTZ" to the user = "1000000" to the RPC, as there are no such thing as decimal places on the network

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​Rpc​AmountDecimal

A decimal conforming to the RPC standard for XTZ. Decimal places will be ignored.

-
-
-
-

- init(from​Normalised​Amount:​) -

-
-
public init(fromNormalisedAmount normalisedAmount: Decimal)  
-
-
-

Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​Normalised​AmountDecimal

A decimal containing an amount for XTZ. Anything over the given decimal places for the token will be ignored.

-
-
-
-

- init?(from​Normalised​Amount:​decimal​Places:​) -

-
-
public convenience init?(fromNormalisedAmount normalisedAmount: String, decimalPlaces: Int)  
-
-
-

Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

- -
-

Parameters

- - - - - - - - - - - - - - - - -
from​Normalised​AmountString

A string containing an amount for XTZ. Anything over the given decimal places for the token will be ignored.

-
-
-
-

- init(from:​) -

-
-
required public init(from decoder: Decoder) throws  
-
-
-

Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info. -This coder attempts to handle both states, first checking if its possible to extract both, if not, defaulting the decimal palces to zero, expecting the calling application to provide this information later on from another proptery or even another API call (such as a metadata query)

- -
-
-
-
-

Methods

- -
-

- zero() -

-
-
public override class func zero() -> XTZAmount  
-
-
-

Quickly create a XTZAmount with zero balance.

- -
-
-
-
-

Operators

- -
-

- + -

-
-
public static func + (lhs: XTZAmount, rhs: XTZAmount) -> XTZAmount  
-
-
-

Overload + operator to allow users to add two Token amounts of the same type, together.

- -
-
-
-

- += -

-
-
public static func += (lhs: inout XTZAmount, rhs: XTZAmount)  
-
-
-

Overload += operator to allow users to add two Token amounts of the same type, together in place.

- -
-
-
-

- - -

-
-
public static func - (lhs: XTZAmount, rhs: XTZAmount) -> XTZAmount  
-
-
-

Overload - operator to allow users to subtract two Token amounts of the same type.

- -
-
-
-

- -= -

-
-
public static func -= (lhs: inout XTZAmount, rhs: XTZAmount)  
-
-
-

Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

- -
-
-
-

- * -

-
-
public static func * (lhs: XTZAmount, rhs: Decimal) -> Decimal  
-
-
-

Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

- -
-
-
-

- * -

-
-
public static func * (lhs: XTZAmount, rhs: Int) -> XTZAmount  
-
-
-

Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

- -
-
-
- - - -
-
- - - - diff --git a/all.css b/all.css deleted file mode 100644 index ac210864..00000000 --- a/all.css +++ /dev/null @@ -1 +0,0 @@ -:root{--system-red:#ff3b30;--system-orange:#ff9500;--system-yellow:#fc0;--system-green:#34c759;--system-teal:#5ac8fa;--system-blue:#007aff;--system-indigo:#5856d6;--system-purple:#af52de;--system-pink:#ff2d55;--system-gray:#8e8e93;--system-gray2:#aeaeb2;--system-gray3:#c7c7cc;--system-gray4:#d1d1d6;--system-gray5:#e5e5ea;--system-gray6:#f2f2f7;--label:#000;--secondary-label:#3c3c43;--tertiary-label:#48484a;--quaternary-label:#636366;--placeholder-text:#8e8e93;--link:#007aff;--separator:#e5e5ea;--opaque-separator:#c6c6c8;--system-fill:#787880;--secondary-system-fill:#787880;--tertiary-system-fill:#767680;--quaternary-system-fill:#747480;--system-background:#fff;--secondary-system-background:#f2f2f7;--tertiary-system-background:#fff;--system-grouped-background:#f2f2f7;--secondary-system-grouped-background:#fff;--tertiary-system-grouped-background:#f2f2f7}@supports (color:color(display-p3 1 1 1)){:root{--system-red:color(display-p3 1 0.2314 0.1882);--system-orange:color(display-p3 1 0.5843 0);--system-yellow:color(display-p3 1 0.8 0);--system-green:color(display-p3 0.2039 0.7804 0.349);--system-teal:color(display-p3 0.3529 0.7843 0.9804);--system-blue:color(display-p3 0 0.4784 1);--system-indigo:color(display-p3 0.3451 0.3373 0.8392);--system-purple:color(display-p3 0.6863 0.3216 0.8706);--system-pink:color(display-p3 1 0.1765 0.3333);--system-gray:color(display-p3 0.5569 0.5569 0.5765);--system-gray2:color(display-p3 0.6824 0.6824 0.698);--system-gray3:color(display-p3 0.7804 0.7804 0.8);--system-gray4:color(display-p3 0.8196 0.8196 0.8392);--system-gray5:color(display-p3 0.898 0.898 0.9176);--system-gray6:color(display-p3 0.949 0.949 0.9686);--label:color(display-p3 0 0 0);--secondary-label:color(display-p3 0.2353 0.2353 0.2627);--tertiary-label:color(display-p3 0.2823 0.2823 0.2901);--quaternary-label:color(display-p3 0.4627 0.4627 0.5019);--placeholder-text:color(display-p3 0.5568 0.5568 0.5764);--link:color(display-p3 0 0.4784 1);--separator:color(display-p3 0.898 0.898 0.9176);--opaque-separator:color(display-p3 0.7765 0.7765 0.7843);--system-fill:color(display-p3 0.4706 0.4706 0.502);--secondary-system-fill:color(display-p3 0.4706 0.4706 0.502);--tertiary-system-fill:color(display-p3 0.4627 0.4627 0.502);--quaternary-system-fill:color(display-p3 0.4549 0.4549 0.502);--system-background:color(display-p3 1 1 1);--secondary-system-background:color(display-p3 0.949 0.949 0.9686);--tertiary-system-background:color(display-p3 1 1 1);--system-grouped-background:color(display-p3 0.949 0.949 0.9686);--secondary-system-grouped-background:color(display-p3 1 1 1);--tertiary-system-grouped-background:color(display-p3 0.949 0.949 0.9686)}}:root{--large-title:600 32pt/39pt sans-serif;--title-1:600 26pt/32pt sans-serif;--title-2:600 20pt/25pt sans-serif;--title-3:500 18pt/23pt sans-serif;--headline:500 15pt/20pt sans-serif;--body:300 15pt/20pt sans-serif;--callout:300 14pt/19pt sans-serif;--subhead:300 13pt/18pt sans-serif;--footnote:300 12pt/16pt sans-serif;--caption-1:300 11pt/13pt sans-serif;--caption-2:300 11pt/13pt sans-serif;--icon-associatedtype:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23ff6682' height='90' rx='8' stroke='%23ff2d55' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M42 81.71V31.3H24.47v-13h51.06v13H58v50.41z' fill='%23fff'/%3E%3C/svg%3E");--icon-case:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%2389c5e6' height='90' rx='8' stroke='%236bb7e1' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M20.21 50c0-20.7 11.9-32.79 30.8-32.79 16 0 28.21 10.33 28.7 25.32H64.19C63.4 35 58.09 30.11 51 30.11c-8.79 0-14.37 7.52-14.37 19.82s5.54 20 14.41 20c7.08 0 12.22-4.66 13.23-12.09h15.52c-.74 15.07-12.43 25-28.78 25C32 82.81 20.21 70.72 20.21 50z' fill='%23fff'/%3E%3C/svg%3E");--icon-class:url("data:image/svg+xml;utf8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%239b98e6' height='90' rx='8' stroke='%235856d6' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='m20.21 50c0-20.7 11.9-32.79 30.8-32.79 16 0 28.21 10.33 28.7 25.32h-15.52c-.79-7.53-6.1-12.42-13.19-12.42-8.79 0-14.37 7.52-14.37 19.82s5.54 20 14.41 20c7.08 0 12.22-4.66 13.23-12.09h15.52c-.74 15.07-12.43 25-28.78 25-19.01-.03-30.8-12.12-30.8-32.84z' fill='%23fff'/%3E%3C/svg%3E");--icon-enumeration:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23eca95b' height='90' rx='8' stroke='%23e89234' stroke-miterlimit='10' stroke-width='4' width='90' x='5.17' y='5'/%3E%3Cpath d='M71.9 81.71H28.43V18.29H71.9v13H44.56v12.62h25.71v11.87H44.56V68.7H71.9z' fill='%23fff'/%3E%3C/svg%3E");--icon-extension:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23eca95b' height='90' rx='8' stroke='%23e89234' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cg fill='%23fff'%3E%3Cpath d='M54.43 81.93H20.51V18.07h33.92v12.26H32.61v13.8h20.45v11.32H32.61v14.22h21.82zM68.74 74.58h-.27l-2.78 7.35h-7.28L64 69.32l-6-12.54h8l2.74 7.3h.27l2.76-7.3h7.64l-6.14 12.54 5.89 12.61h-7.64z'/%3E%3C/g%3E%3C/svg%3E");--icon-function:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%237ac673' height='90' rx='8' stroke='%235bb74f' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M24.25 75.66A5.47 5.47 0 0 1 30 69.93c1.55 0 3.55.41 6.46.41 3.19 0 4.78-1.55 5.46-6.65l1.5-10.14h-9.34a6 6 0 1 1 0-12h11.1l1.09-7.27C47.82 23.39 54.28 17.7 64 17.7c6.69 0 11.74 1.77 11.74 6.64A5.47 5.47 0 0 1 70 30.07c-1.55 0-3.55-.41-6.46-.41-3.14 0-4.73 1.51-5.46 6.65l-.78 5.27h11.44a6 6 0 1 1 .05 12H55.6l-1.78 12.11C52.23 76.61 45.72 82.3 36 82.3c-6.7 0-11.75-1.77-11.75-6.64z' fill='%23fff'/%3E%3C/svg%3E");--icon-method:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%235a98f8' height='90' rx='8' stroke='%232974ed' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M70.61 81.71v-39.6h-.31l-15.69 39.6h-9.22l-15.65-39.6h-.35v39.6H15.2V18.29h18.63l16 41.44h.36l16-41.44H84.8v63.42z' fill='%23fff'/%3E%3C/svg%3E");--icon-operator:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%237ac673' height='90' rx='8' stroke='%235bb74f' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Ccircle fill='%23fff' cx='50' cy='50' r='16'/%3E%3C/svg%3E");--icon-property:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%2389c5e6' height='90' rx='8' stroke='%236bb7e1' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M52.31 18.29c13.62 0 22.85 8.84 22.85 22.46s-9.71 22.37-23.82 22.37H41v18.59H24.84V18.29zM41 51h7c6.85 0 10.89-3.56 10.89-10.2S54.81 30.64 48 30.64h-7z' fill='%23fff'/%3E%3C/svg%3E");--icon-protocol:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23ff6682' height='90' rx='8' stroke='%23ff2d55' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cg fill='%23fff'%3E%3Cpath d='M46.28 18.29c11.84 0 20 8.66 20 21.71s-8.44 21.71-20.6 21.71H34.87v20H22.78V18.29zM34.87 51.34H43c6.93 0 11-4 11-11.29S50 28.8 43.07 28.8h-8.2zM62 57.45h8v4.77h.16c.84-3.45 2.54-5.12 5.17-5.12a5.06 5.06 0 0 1 1.92.35V65a5.69 5.69 0 0 0-2.39-.51c-3.08 0-4.66 1.74-4.66 5.12v12.1H62z'/%3E%3C/g%3E%3C/svg%3E");--icon-structure:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23b57edf' height='90' rx='8' stroke='%239454c2' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M38.38 63c.74 4.53 5.62 7.16 11.82 7.16s10.37-2.81 10.37-6.68c0-3.51-2.73-5.31-10.24-6.76l-6.5-1.23C31.17 53.14 24.62 47 24.62 37.28c0-12.22 10.59-20.09 25.18-20.09 16 0 25.36 7.83 25.53 19.91h-15c-.26-4.57-4.57-7.29-10.42-7.29s-9.31 2.63-9.31 6.37c0 3.34 2.9 5.18 9.8 6.5l6.5 1.23C70.46 46.51 76.61 52 76.61 62c0 12.74-10 20.83-26.72 20.83-15.82 0-26.28-7.3-26.5-19.78z' fill='%23fff'/%3E%3C/svg%3E");--icon-typealias:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%237ac673' height='90' rx='8' stroke='%235bb74f' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M42 81.71V31.3H24.47v-13h51.06v13H58v50.41z' fill='%23fff'/%3E%3C/svg%3E");--icon-variable:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%237ac673' height='90' rx='8' stroke='%235bb74f' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M39.85 81.71 19.63 18.29H38l12.18 47.64h.35L62.7 18.29h17.67L60.15 81.71z' fill='%23fff'/%3E%3C/svg%3E")}body,button,input,select,textarea{-moz-font-feature-settings:"kern";-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased;direction:ltr;font-synthesis:none;text-align:left}h1:first-of-type,h2:first-of-type,h3:first-of-type,h4:first-of-type,h5:first-of-type,h6:first-of-type{margin-top:0}h1 code,h2 code,h3 code,h4 code,h5 code,h6 code{font-family:inherit;font-weight:inherit}h1 img,h2 img,h3 img,h4 img,h5 img,h6 img{display:inline-block;margin:0 .5em .2em 0;vertical-align:middle}h1+*,h2+*,h3+*,h4+*,h5+*,h6+*{margin-top:.8em}img+h1{margin-top:.5em}img+h1,img+h2,img+h3,img+h4,img+h5,img+h6{margin-top:.3em}:is(h1)+:is(h1),:is(h1)+:is(h2),:is(h1)+:is(h3),:is(h1)+:is(h4),:is(h1)+:is(h5),:is(h1)+:is(h6),:is(h2)+:is(h1),:is(h2)+:is(h2),:is(h2)+:is(h3),:is(h2)+:is(h4),:is(h2)+:is(h5),:is(h2)+:is(h6),:is(h3)+:is(h1),:is(h3)+:is(h2),:is(h3)+:is(h3),:is(h3)+:is(h4),:is(h3)+:is(h5),:is(h3)+:is(h6),:is(h4)+:is(h1),:is(h4)+:is(h2),:is(h4)+:is(h3),:is(h4)+:is(h4),:is(h4)+:is(h5),:is(h4)+:is(h6),:is(h5)+:is(h1),:is(h5)+:is(h2),:is(h5)+:is(h3),:is(h5)+:is(h4),:is(h5)+:is(h5),:is(h5)+:is(h6),:is(h6)+:is(h1),:is(h6)+:is(h2),:is(h6)+:is(h3),:is(h6)+:is(h4),:is(h6)+:is(h5),:is(h6)+:is(h6){margin-top:.4em}h1+h1,h1+h2,h1+h3,h1+h4,h1+h5,h1+h6,h2+h1,h2+h2,h2+h3,h2+h4,h2+h5,h2+h6,h3+h1,h3+h2,h3+h3,h3+h4,h3+h5,h3+h6,h4+h1,h4+h2,h4+h3,h4+h4,h4+h5,h4+h6,h5+h1,h5+h2,h5+h3,h5+h4,h5+h5,h5+h6,h6+h1,h6+h2,h6+h3,h6+h4,h6+h5,h6+h6{margin-top:.4em}:is(p,ul,ol)+:is(h1),:is(p,ul,ol)+:is(h2),:is(p,ul,ol)+:is(h3),:is(p,ul,ol)+:is(h4),:is(p,ul,ol)+:is(h5),:is(p,ul,ol)+:is(h6){margin-top:1.6em}ol+h1,ol+h2,ol+h3,ol+h4,ol+h5,ol+h6,p+h1,p+h2,p+h3,p+h4,p+h5,p+h6,ul+h1,ul+h2,ul+h3,ul+h4,ul+h5,ul+h6{margin-top:1.6em}:is(p,ul,ol)+*{margin-top:.8em}:matches(p,ul,ol)+*{margin-top:.8em}ol,ul{margin-left:1.17647em}:matches(ul,ol) :matches(ul,ol){margin-bottom:0;margin-top:0}nav h2{-webkit-font-feature-settings:"c2sc";font-feature-settings:"c2sc";color:#3c3c43;color:var(--secondary-label);font-size:1rem;font-variant:small-caps;font-weight:600;text-transform:uppercase}nav ol,nav ul{list-style:none;margin:0}nav li li{font-size:smaller}a:link,a:visited{text-decoration:none}a:hover{text-decoration:underline}a:active{text-decoration:none}b,strong{font-weight:600}.discussion,.summary{font:300 14pt/19pt sans-serif;font:var(--callout)}article>.discussion{margin-bottom:2em}.discussion .highlight{background:transparent;border:1px solid #e5e5ea;border:1px solid var(--separator);font:300 11pt/13pt sans-serif;font:var(--caption-1);padding:1em;text-indent:0}cite,dfn,em,i{font-style:italic}:matches(h1,h2,h3) sup{font-size:.4em}sup a{color:inherit;vertical-align:inherit}sup a:hover{color:#007aff;color:var(--link);text-decoration:none}sub{line-height:1}abbr{border:0}:lang(ja),:lang(ko),:lang(th),:lang(zh){font-style:normal}:lang(ko){word-break:keep-all}form fieldset{margin:1em auto;max-width:450px;width:95%}form label{display:block;font-size:1em;font-weight:400;line-height:1.5em;margin-bottom:14px;position:relative;width:100%}input[type=email],input[type=number],input[type=password],input[type=tel],input[type=text],input[type=url],textarea{border:1px solid #e5e5ea;border:1px solid var(--separator);border-radius:4px;color:#333;font-family:inherit;font-size:100%;font-weight:400;height:34px;margin:0;padding:0 1em;position:relative;vertical-align:top;width:100%;z-index:1}input[type=email],input[type=email]:focus,input[type=number],input[type=number]:focus,input[type=password],input[type=password]:focus,input[type=tel],input[type=tel]:focus,input[type=text],input[type=text]:focus,input[type=url],input[type=url]:focus,textarea,textarea:focus{-webkit-appearance:none;-moz-appearance:none;appearance:none}input[type=email]:focus,input[type=number]:focus,input[type=password]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=url]:focus,textarea:focus{border-color:#08c;box-shadow:0 0 0 3px rgba(0,136,204,.3);outline:0;z-index:9}input[type=email]:-moz-read-only,input[type=number]:-moz-read-only,input[type=password]:-moz-read-only,input[type=tel]:-moz-read-only,input[type=text]:-moz-read-only,input[type=url]:-moz-read-only,textarea:-moz-read-only{background:none;border:none;box-shadow:none;padding-left:0}input[type=email]:read-only,input[type=number]:read-only,input[type=password]:read-only,input[type=tel]:read-only,input[type=text]:read-only,input[type=url]:read-only,textarea:read-only{background:none;border:none;box-shadow:none;padding-left:0}::-webkit-input-placeholder{color:#8e8e93;color:var(--placeholder-text)}::-moz-placeholder{color:#8e8e93;color:var(--placeholder-text)}::-ms-input-placeholder{color:#8e8e93;color:var(--placeholder-text)}::placeholder{color:#8e8e93;color:var(--placeholder-text)}textarea{-webkit-overflow-scrolling:touch;line-height:1.4737;min-height:134px;overflow-y:auto;resize:vertical;-webkit-transform:translateZ(0);transform:translateZ(0)}textarea,textarea:focus{-webkit-appearance:none;-moz-appearance:none;appearance:none}select{background:transparent;border:none;border-radius:4px;cursor:pointer;font-family:inherit;font-size:1em;height:34px;margin:0;padding:0 1em;width:100%}select,select:focus{-webkit-appearance:none;-moz-appearance:none;appearance:none}select:focus{border-color:#08c;box-shadow:0 0 0 3px rgba(0,136,204,.3);outline:0;z-index:9}input[type=file]{background:#fafafa;border-radius:4px;color:#333;cursor:pointer;font-family:inherit;font-size:100%;height:34px;margin:0;padding:6px 1em;position:relative;vertical-align:top;width:100%;z-index:1}input[type=file]:focus{border-color:#08c;box-shadow:0 0 0 3px rgba(0,136,204,.3);outline:0;z-index:9}button,button:focus,input[type=file]:focus,input[type=file]:focus:focus,input[type=reset],input[type=reset]:focus,input[type=submit],input[type=submit]:focus{-webkit-appearance:none;-moz-appearance:none;appearance:none}:matches(button,input[type=reset],input[type=submit]){background-color:#e3e3e3;background:linear-gradient(#fff,#e3e3e3);border-color:#d6d6d6;color:#0070c9}:matches(button,input[type=reset],input[type=submit]):hover{background-color:#eee;background:linear-gradient(#fff,#eee);border-color:#d9d9d9}:matches(button,input[type=reset],input[type=submit]):active{background-color:#dcdcdc;background:linear-gradient(#f7f7f7,#dcdcdc);border-color:#d0d0d0}:matches(button,input[type=reset],input[type=submit]):disabled{background-color:#e3e3e3;background:linear-gradient(#fff,#e3e3e3);border-color:#d6d6d6;color:#0070c9}body{background:#f2f2f7;background:var(--system-grouped-background);color:#000;color:var(--label);font-family:ui-system,-apple-system,BlinkMacSystemFont,sans-serif;font:300 15pt/20pt sans-serif;font:var(--body)}h1{font:600 32pt/39pt sans-serif;font:var(--large-title)}h2{font:600 20pt/25pt sans-serif;font:var(--title-2)}h3{font:500 18pt/23pt sans-serif;font:var(--title-3)}h4,h5,h6{font:500 15pt/20pt sans-serif;font:var(--headline)}a{color:#007aff;color:var(--link)}label{font:300 14pt/19pt sans-serif;font:var(--callout)}input,label{display:block}input{margin-bottom:1em}hr{border:none;border-top:1px solid #e5e5ea;border-top:1px solid var(--separator);margin:1em 0}table{caption-side:bottom;font:300 11pt/13pt sans-serif;font:var(--caption-1);margin-bottom:2em;width:100%}td,th{padding:0 1em}th{font-weight:600;text-align:left}thead th{border-bottom:1px solid #e5e5ea;border-bottom:1px solid var(--separator)}tr:last-of-type td,tr:last-of-type th{border-bottom:none}td,th{border-bottom:1px solid #e5e5ea;border-bottom:1px solid var(--separator);color:#3c3c43;color:var(--secondary-label)}caption{color:#48484a;color:var(--tertiary-label);font:300 11pt/13pt sans-serif;font:var(--caption-2);margin-top:2em;text-align:left}.graph text,code{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-weight:300}.graph>polygon{display:none}.graph text{fill:currentColor!important}.graph ellipse,.graph path,.graph polygon,.graph rect{stroke:currentColor!important}body{margin:1em auto;max-width:1280px;width:90vw}body>header{font:600 26pt/32pt sans-serif;font:var(--title-1);padding:.5em 0}body>header a{color:#000;color:var(--label)}body>header span{font-weight:400}body>header sup{font-size:small;font-weight:300;letter-spacing:.1ch;text-transform:uppercase}body>footer,body>header sup{color:#3c3c43;color:var(--secondary-label)}body>footer{clear:both;font:300 11pt/13pt sans-serif;font:var(--caption-1);padding:1em 0}@media screen and (max-width:768px){body{max-width:100%;width:96vw}body>header{font:500 18pt/23pt sans-serif;font:var(--title-3);padding:1em 0;text-align:left}body>nav{display:none}body>main{padding:0 1em}#relationships figure{display:none}section>[role=article][class] pre{margin-left:-1em;margin-right:-1em}section>[role=article][class] div{margin-left:-2em}}main,nav{overflow-x:auto}main{background:#fff;background:var(--system-background);border-radius:8px;padding:0 2em}main section{border-bottom:1px solid #e5e5ea;border-bottom:1px solid var(--separator);margin-bottom:2em;padding-bottom:1em}main section:last-of-type{border-bottom:none;margin-bottom:0}nav{float:right;margin-left:1em;max-height:100vh;max-width:14em;overflow:auto;padding:0 1em 3em;position:sticky;top:1em;width:20vw}nav a{color:#3c3c43;color:var(--secondary-label)}nav ul a{color:#48484a;color:var(--tertiary-label)}nav ol,nav ul{padding:0}nav ul{font:300 14pt/19pt sans-serif;font:var(--callout);margin-bottom:1em}nav ol>li>a{display:block;font-size:smaller;font:500 15pt/20pt sans-serif;font:var(--headline);margin:.5em 0}nav li{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}blockquote{--link:#3c3c43;--link:var(--secondary-label);border-left:4px solid #e5e5ea;border-left:4px solid var(--separator);color:#3c3c43;color:var(--secondary-label);font-size:smaller;margin-left:0;padding-left:2em}blockquote a{text-decoration:underline}.discussion aside{--link:var(--accent-color);border:.25px solid #e5e5ea;border-left:6px solid #e5e5ea;border:.25px solid var(--separator);border-bottom-left-radius:8px;border-bottom-right-radius:8px;border-left-width:6px;border-top-left-radius:8px;border-top-right-radius:8px;color:var(--accent-color);margin-bottom:1em;padding:.125em 1em}.discussion aside:before{-webkit-font-feature-settings:"c2sc";font-feature-settings:"c2sc";color:var(--accent-color);content:attr(title);font-variant:small-caps;text-transform:lowercase}.discussion aside>p{margin-bottom:.25em;margin-top:.25em}.discussion aside{--accent-color:#000049;--separator:#007aff;--separator:var(--system-blue);background:rgba(0,122,255,.01)}.discussion aside.author,.discussion aside.authors,.discussion aside.copyright,.discussion aside.date{--accent-color:#333;--separator:#787880;--separator:var(--system-fill);background:#fff;background:var(--system-background)}.discussion aside.attention,.discussion aside.important,.discussion aside.warning{--accent-color:#4c2502;--separator:#ff9500;--separator:var(--system-orange);background:rgba(255,149,0,.01)}.discussion aside.bug{--accent-color:#4e0029;--separator:#ff2d55;--separator:var(--system-pink);background:rgba(255,59,48,.01)}article{padding:2em 0 1em}article>.summary{border-bottom:1px solid #e5e5ea;border-bottom:1px solid var(--separator);margin-bottom:2em;padding-bottom:1em}article>.summary:last-child{border-bottom:none}.parameters th{text-align:right}.parameters td{color:#3c3c43;color:var(--secondary-label)}.parameters th+td{text-align:center}dl{padding-top:1em}dt{font:500 15pt/20pt sans-serif;font:var(--headline)}dd{margin-bottom:1em;margin-left:2em}dd p{margin-top:0}.highlight{background:#f2f2f7;background:var(--secondary-system-background);border-radius:8px;font-size:.75em;margin-bottom:2em;overflow-x:auto;padding:1em 1em 1em 3em;text-indent:-2em;white-space:pre-wrap}.highlight .p{white-space:nowrap}.highlight .placeholder{color:#000;color:var(--label)}.highlight a{color:#8e8e93;color:var(--placeholder-text);text-decoration:underline}.highlight .attribute,.highlight .keyword,.highlight .literal{color:#af52de;color:var(--system-purple)}.highlight .number{color:#007aff;color:var(--system-blue)}.highlight .declaration{color:#5ac8fa;color:var(--system-teal)}.highlight .type{color:#5856d6;color:var(--system-indigo)}.highlight .directive{color:#ff9500;color:var(--system-orange)}.highlight .comment{color:#8e8e93;color:var(--system-gray)}main summary:hover{text-decoration:underline}figure{margin:2em 0;padding:1em 0}figure svg{display:block;height:auto!important;margin:0 auto;max-width:100%}h1 small{color:#636366;color:var(--quaternary-label);display:block;font-size:.5em;font-weight:400;line-height:1.5}h3 small{color:#48484a;color:var(--tertiary-label)}dd code,li code,p code{font-size:smaller}a code{text-decoration:underline}dl dt[class],nav li[class],section>[role=article][class]{background-image:var(--background-image);background-position:left .25em;background-repeat:no-repeat;background-size:1em;padding-left:3em}dl dt[class]{background-position-y:.125em}section>[role=article]{border-bottom:1px solid #e5e5ea;border-bottom:1px solid var(--separator);margin-bottom:1em;padding-bottom:1em;padding-left:2em!important}section>[role=article]:last-of-type{border-bottom:none;margin-bottom:0;padding-bottom:0}dl dt[class],nav li[class]{list-style:none;margin-bottom:.5em;text-indent:-1em}nav li[class]{padding-left:2.5em}.associatedtype{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23ff6682' height='90' rx='8' stroke='%23ff2d55' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M42 81.71V31.3H24.47v-13h51.06v13H58v50.41z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-associatedtype);--link:#ff2d55;--link:var(--system-pink)}.case,.enumeration_case{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%2389c5e6' height='90' rx='8' stroke='%236bb7e1' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M20.21 50c0-20.7 11.9-32.79 30.8-32.79 16 0 28.21 10.33 28.7 25.32H64.19C63.4 35 58.09 30.11 51 30.11c-8.79 0-14.37 7.52-14.37 19.82s5.54 20 14.41 20c7.08 0 12.22-4.66 13.23-12.09h15.52c-.74 15.07-12.43 25-28.78 25C32 82.81 20.21 70.72 20.21 50z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-case);--link:#5ac8fa;--link:var(--system-teal)}.class{--background-image:url("data:image/svg+xml;utf8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%239b98e6' height='90' rx='8' stroke='%235856d6' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='m20.21 50c0-20.7 11.9-32.79 30.8-32.79 16 0 28.21 10.33 28.7 25.32h-15.52c-.79-7.53-6.1-12.42-13.19-12.42-8.79 0-14.37 7.52-14.37 19.82s5.54 20 14.41 20c7.08 0 12.22-4.66 13.23-12.09h15.52c-.74 15.07-12.43 25-28.78 25-19.01-.03-30.8-12.12-30.8-32.84z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-class);--link:#5856d6;--link:var(--system-indigo)}.enumeration{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23eca95b' height='90' rx='8' stroke='%23e89234' stroke-miterlimit='10' stroke-width='4' width='90' x='5.17' y='5'/%3E%3Cpath d='M71.9 81.71H28.43V18.29H71.9v13H44.56v12.62h25.71v11.87H44.56V68.7H71.9z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-enumeration);--link:#ff9500;--link:var(--system-orange)}.extension{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23eca95b' height='90' rx='8' stroke='%23e89234' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cg fill='%23fff'%3E%3Cpath d='M54.43 81.93H20.51V18.07h33.92v12.26H32.61v13.8h20.45v11.32H32.61v14.22h21.82zM68.74 74.58h-.27l-2.78 7.35h-7.28L64 69.32l-6-12.54h8l2.74 7.3h.27l2.76-7.3h7.64l-6.14 12.54 5.89 12.61h-7.64z'/%3E%3C/g%3E%3C/svg%3E");--background-image:var(--icon-extension);--link:#ff9500;--link:var(--system-orange)}.function{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%237ac673' height='90' rx='8' stroke='%235bb74f' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M24.25 75.66A5.47 5.47 0 0 1 30 69.93c1.55 0 3.55.41 6.46.41 3.19 0 4.78-1.55 5.46-6.65l1.5-10.14h-9.34a6 6 0 1 1 0-12h11.1l1.09-7.27C47.82 23.39 54.28 17.7 64 17.7c6.69 0 11.74 1.77 11.74 6.64A5.47 5.47 0 0 1 70 30.07c-1.55 0-3.55-.41-6.46-.41-3.14 0-4.73 1.51-5.46 6.65l-.78 5.27h11.44a6 6 0 1 1 .05 12H55.6l-1.78 12.11C52.23 76.61 45.72 82.3 36 82.3c-6.7 0-11.75-1.77-11.75-6.64z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-function);--link:#34c759;--link:var(--system-green)}.initializer,.method{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%235a98f8' height='90' rx='8' stroke='%232974ed' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M70.61 81.71v-39.6h-.31l-15.69 39.6h-9.22l-15.65-39.6h-.35v39.6H15.2V18.29h18.63l16 41.44h.36l16-41.44H84.8v63.42z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-method);--link:#007aff;--link:var(--system-blue)}.operator{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%237ac673' height='90' rx='8' stroke='%235bb74f' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Ccircle fill='%23fff' cx='50' cy='50' r='16'/%3E%3C/svg%3E");--background-image:var(--icon-operator);--link:#34c759;--link:var(--system-green)}.property{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%2389c5e6' height='90' rx='8' stroke='%236bb7e1' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M52.31 18.29c13.62 0 22.85 8.84 22.85 22.46s-9.71 22.37-23.82 22.37H41v18.59H24.84V18.29zM41 51h7c6.85 0 10.89-3.56 10.89-10.2S54.81 30.64 48 30.64h-7z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-property);--link:#5ac8fa;--link:var(--system-teal)}.protocol{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23ff6682' height='90' rx='8' stroke='%23ff2d55' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cg fill='%23fff'%3E%3Cpath d='M46.28 18.29c11.84 0 20 8.66 20 21.71s-8.44 21.71-20.6 21.71H34.87v20H22.78V18.29zM34.87 51.34H43c6.93 0 11-4 11-11.29S50 28.8 43.07 28.8h-8.2zM62 57.45h8v4.77h.16c.84-3.45 2.54-5.12 5.17-5.12a5.06 5.06 0 0 1 1.92.35V65a5.69 5.69 0 0 0-2.39-.51c-3.08 0-4.66 1.74-4.66 5.12v12.1H62z'/%3E%3C/g%3E%3C/svg%3E");--background-image:var(--icon-protocol);--link:#ff2d55;--link:var(--system-pink)}.structure{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%23b57edf' height='90' rx='8' stroke='%239454c2' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M38.38 63c.74 4.53 5.62 7.16 11.82 7.16s10.37-2.81 10.37-6.68c0-3.51-2.73-5.31-10.24-6.76l-6.5-1.23C31.17 53.14 24.62 47 24.62 37.28c0-12.22 10.59-20.09 25.18-20.09 16 0 25.36 7.83 25.53 19.91h-15c-.26-4.57-4.57-7.29-10.42-7.29s-9.31 2.63-9.31 6.37c0 3.34 2.9 5.18 9.8 6.5l6.5 1.23C70.46 46.51 76.61 52 76.61 62c0 12.74-10 20.83-26.72 20.83-15.82 0-26.28-7.3-26.5-19.78z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-structure);--link:#af52de;--link:var(--system-purple)}.typealias{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%237ac673' height='90' rx='8' stroke='%235bb74f' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M42 81.71V31.3H24.47v-13h51.06v13H58v50.41z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-typealias);--link:#34c759;--link:var(--system-green)}.variable{--background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 100 100' xmlns='http://www.w3.org/2000/svg'%3E%3Crect fill='%237ac673' height='90' rx='8' stroke='%235bb74f' stroke-miterlimit='10' stroke-width='4' width='90' x='5' y='5'/%3E%3Cpath d='M39.85 81.71 19.63 18.29H38l12.18 47.64h.35L62.7 18.29h17.67L60.15 81.71z' fill='%23fff'/%3E%3C/svg%3E");--background-image:var(--icon-variable);--link:#34c759;--link:var(--system-green)}.unknown{--link:#636366;--link:var(--quaternary-label);color:#007aff;color:var(--link)} \ No newline at end of file diff --git a/badge.svg b/badge.svg new file mode 100644 index 00000000..a096feca --- /dev/null +++ b/badge.svg @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + documentation + + + documentation + + + 100% + + + 100% + + + diff --git a/css/highlight.css b/css/highlight.css new file mode 100644 index 00000000..c170357c --- /dev/null +++ b/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/css/jazzy.css b/css/jazzy.css new file mode 100644 index 00000000..2e387139 --- /dev/null +++ b/css/jazzy.css @@ -0,0 +1,439 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td { + background: transparent; + border: 0; + margin: 0; + outline: 0; + padding: 0; + vertical-align: baseline; } + +body { + background-color: #f2f2f2; + font-family: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + -webkit-font-smoothing: subpixel-antialiased; + word-wrap: break-word; } + +h1, h2, h3 { + margin-top: 0.8em; + margin-bottom: 0.3em; + font-weight: 100; + color: black; } + +h1 { + font-size: 2.5em; } + +h2 { + font-size: 2em; + border-bottom: 1px solid #e2e2e2; } + +h4 { + font-size: 13px; + line-height: 1.5; + margin-top: 21px; } + +h5 { + font-size: 1.1em; } + +h6 { + font-size: 1.1em; + color: #777; } + +.section-name { + color: gray; + display: block; + font-family: Helvetica; + font-size: 22px; + font-weight: 100; + margin-bottom: 15px; } + +pre, code { + font: 0.95em Menlo, monospace; + color: #777; + word-wrap: normal; } + +p code, li code { + background-color: #eee; + padding: 2px 4px; + border-radius: 4px; } + +pre > code { + padding: 0; } + +a { + color: #0088cc; + text-decoration: none; } + a code { + color: inherit; } + +ul { + padding-left: 15px; } + +li { + line-height: 1.8em; } + +img { + max-width: 100%; } + +blockquote { + margin-left: 0; + padding: 0 10px; + border-left: 4px solid #ccc; } + +hr { + height: 1px; + border: none; + background-color: #e2e2e2; } + +.footnote-ref { + display: inline-block; + scroll-margin-top: 70px; } + +.footnote-def { + scroll-margin-top: 70px; } + +.content-wrapper { + margin: 0 auto; + width: 980px; } + +header { + font-size: 0.85em; + line-height: 32px; + background-color: #414141; + position: fixed; + width: 100%; + z-index: 3; } + header img { + padding-right: 6px; + vertical-align: -3px; + height: 16px; } + header a { + color: #fff; } + header p { + float: left; + color: #999; } + header .header-right { + float: right; + margin-left: 16px; } + +#breadcrumbs { + background-color: #f2f2f2; + height: 21px; + padding-top: 17px; + position: fixed; + width: 100%; + z-index: 2; + margin-top: 32px; } + #breadcrumbs #carat { + height: 10px; + margin: 0 5px; } + +.sidebar { + background-color: #f9f9f9; + border: 1px solid #e2e2e2; + overflow-y: auto; + overflow-x: hidden; + position: fixed; + top: 70px; + bottom: 0; + width: 230px; + word-wrap: normal; } + +.nav-groups { + list-style-type: none; + background: #fff; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #e2e2e2; + font-size: 1.1em; + font-weight: 100; + padding: 15px 0 15px 20px; } + .nav-group-name > a { + color: #333; } + +.nav-group-tasks { + margin-top: 5px; } + +.nav-group-task { + font-size: 0.9em; + list-style-type: none; + white-space: nowrap; } + .nav-group-task a { + color: #888; } + +.main-content { + background-color: #fff; + border: 1px solid #e2e2e2; + margin-left: 246px; + position: absolute; + overflow: hidden; + padding-bottom: 20px; + top: 70px; + width: 734px; } + .main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote { + margin-bottom: 1em; } + .main-content p { + line-height: 1.8em; } + .main-content section .section:first-child { + margin-top: 0; + padding-top: 0; } + .main-content section .task-group-section .task-group:first-of-type { + padding-top: 10px; } + .main-content section .task-group-section .task-group:first-of-type .section-name { + padding-top: 15px; } + .main-content section .heading:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + .main-content .section-name p { + margin-bottom: inherit; + line-height: inherit; } + .main-content .section-name code { + background-color: inherit; + padding: inherit; + color: inherit; } + +.section { + padding: 0 25px; } + +.highlight { + background-color: #eee; + padding: 10px 12px; + border: 1px solid #e2e2e2; + border-radius: 4px; + overflow-x: auto; } + +.declaration .highlight { + overflow-x: initial; + padding: 0 40px 40px 0; + margin-bottom: -25px; + background-color: transparent; + border: none; } + +.section-name { + margin: 0; + margin-left: 18px; } + +.task-group-section { + margin-top: 10px; + padding-left: 6px; + border-top: 1px solid #e2e2e2; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + +.section-name-container { + position: relative; + display: inline-block; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + .item code { + background-color: transparent; + padding: 0; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 35px; + font-size: 11.9px; + transition: all 300ms; } + .item .token-open { + margin-left: 20px; } + .item .discouraged { + text-decoration: line-through; } + .item .declaration-note { + font-size: .85em; + color: gray; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #e2e2e2; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + background: #f9f9f9; + border-left: 1px solid #e2e2e2; + border-top: 1px solid #e2e2e2; + height: 12px; + left: 21px; + top: -7px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + position: absolute; + width: 12px; } + +.height-container { + display: none; + left: -25px; + padding: 0 25px; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #f9f9f9; + border-bottom: 1px solid #e2e2e2; + left: -25px; + position: relative; + width: 100%; + padding-top: 10px; + padding-bottom: 5px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4b8afb; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #e2e2e2; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +#footer { + position: relative; + top: 10px; + bottom: 0px; + margin-left: 25px; } + #footer p { + margin: 0; + color: #aaa; + font-size: 0.8em; } + +html.dash header, html.dash #breadcrumbs, html.dash .sidebar { + display: none; } + +html.dash .main-content { + width: 980px; + margin-left: 0; + border: none; + width: 100%; + top: 0; + padding-bottom: 0; } + +html.dash .height-container { + display: block; } + +html.dash .item .token { + margin-left: 0; } + +html.dash .content-wrapper { + width: auto; } + +html.dash #footer { + position: static; } + +form[role=search] { + float: right; } + form[role=search] input { + font: Helvetica, freesans, Arial, sans-serif; + margin-top: 6px; + font-size: 13px; + line-height: 20px; + padding: 0px 10px; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fff; + color: #333; + border: 1px solid #e2e2e2; + z-index: 4; } + form[role=search] .tt-highlight { + font-weight: bold; } + form[role=search] .tt-suggestion { + font: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + form[role=search] .tt-suggestion:hover, + form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + form[role=search] .tt-suggestion:hover .doc-parent-name, + form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docsets/.docset/Contents/Info.plist b/docsets/.docset/Contents/Info.plist new file mode 100644 index 00000000..df4a899c --- /dev/null +++ b/docsets/.docset/Contents/Info.plist @@ -0,0 +1,22 @@ + + + + + CFBundleIdentifier + com.jazzy. + CFBundleName + + DocSetPlatformFamily + + isDashDocset + + dashIndexFilePath + index.html + isJavaScriptEnabled + + DashDocSetFamily + dashtoc + DashDocSetFallbackURL + https://kukai-core-swift.kukai.app/ + + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes.html b/docsets/.docset/Contents/Resources/Documents/Classes.html new file mode 100644 index 00000000..45246ca2 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -0,0 +1,1969 @@ + + + + Classes Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Classes

+

The following classes are available globally.

+ +
+
+
+
    +
  • +
    + + + + BetterCallDevClient + +
    +
    +
    +
    +
    +
    +

    BetterCallDev (BCD) is an indexer/smart contract debugging tool, used for the Tezos blockchain. +This class allows developers to interact with their API, to fetch data that would otherwise be impossible for a mobile app to fetch from the Tezos RPC

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class BetterCallDevClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupClient + +
    +
    +
    +
    +
    +
    +

    This client exposes functions to allow communication to the indexer platform DipDup ( https://dipdup.net/ ). +DipDup is composed of many small, dedicated indexers, powered by GraphQL. This client tries to exposes userflow functions, allowing users to accomplish tasks without having to worry about the underlying complexities

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class DipDupClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktClient + +
    +
    +
    +
    +
    +
    +

    Client for interacting with the API of the popular NFT marketplace, OBJKT.com +Client exposes functions for fetching metadata, pricing, purchase offers, listing etc

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class ObjktClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosDomainsClient + +
    +
    +
    +
    +
    +
    +

    A client class allowing integration with the tezos domains GraphQL API. See more here: https://tezos.domains/

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TezosDomainsClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosNodeClient + +
    +
    +
    +
    +
    +
    +

    The TezosNodeClient offers methods for interacting with the Tezos node to fetch balances, send transactions etc. +The client will abstract away all the compelx tasks of remote forging, parsing, signing, preapply and injecting operations. +It will also convert amounts from the network into Token objects to make common tasks easier.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TezosNodeClient
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTClient + +
    +
    +
    +
    +
    +
    +

    TzKT is an indexer for Tezos, who’s API allows developers to query details about wallets, transactions, bakers, account status etc

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TzKTClient
    +
    extension TzKTClient: HubConnectionDelegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationFactory + +
    +
    +
    +
    +
    +
    +

    Class responsible for creating operations necessary to perform a given action, and converting those operations into the single payload expected by the RPC. +Although not every action requires more than one operation, all functions will return an array, for consistency.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationFactory
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A model matching the response that comes back from BetterCallDev’s API: v1/tokens/<network>/metadata?contract=<address>

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class BetterCallDevTokenMetadata : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + HDWallet + +
    +
    +
    +
    +
    +
    +

    A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

    + +

    This wallet is a HD wallet, allowing the creation of many child wallets from the one base privateKey. It also follows the Bip39 stnadard for generation via a mnemonic.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class HDWallet : Wallet
    +
    extension HDWallet: Equatable
    +
    extension HDWallet: Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LedgerWallet + +
    +
    +
    +
    +
    +
    +

    A Tezos wallet class, used to cache infomration regarding the paired ledger device used to sign the payload. +This class can only be created by fetching data from a Ledger device and supplying this data to the constructor.

    + +

    It is not possible to call the async sign function of this class, it will return null. Signing with a ledger is a complicated async process. +Please use the LedgerService class to setup a bluetooth connection, connect to the device and request a payload signing.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class LedgerWallet : Wallet
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Operation + +
    +
    +
    +
    +
    +
    +

    Base class representing an Operation on the Tezos network. On its own this class can’t be sent to the network. See its subclasses for more info.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class Operation : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Operation subclass for revealing a publickey to the network.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationActivateAccount : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationBallot + +
    +
    +
    +
    +
    +
    +

    Operation to submit a ballot on an upcoming proposal

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationBallot : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationDelegation + +
    +
    +
    +
    +
    +
    +

    Operation subclass for delegating an account to a baker

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationDelegation : Operation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Operation to report a baking of baking the same block twice

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationDoubleBakingEvidence : Operation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Operation to report a baker trying to endorse a block twice

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationDoubleEndorsementEvidence : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationEndorsement + +
    +
    +
    +
    +
    +
    +

    Operation for endorsing a block

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationEndorsement : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationOrigination + +
    +
    +
    +
    +
    +
    +

    Operation subclass for originating a contract on the Tezos network

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationOrigination : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationProposals + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationProposals : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationReveal + +
    +
    +
    +
    +
    +
    +

    Operation subclass for revealing a publickey to the network.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationReveal : Operation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Operation to reveal seed nonce to blockchain

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationSeedNonceRevelation : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationTransaction + +
    +
    +
    +
    +
    +
    +

    Operation subclass for sending XTZ to a destination

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationTransaction : Operation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + RPC + +
    +
    +
    +
    +
    +
    +

    A generic class representing an RPC call to the Tezos network. +A type must be passed in when creating an instance of this object, this will be used by the network layer to parse the response and detect errors.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class RPC<T> where T : Decodable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + RegularWallet + +
    +
    +
    +
    +
    +
    +

    A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

    + +

    This wallet is a non-HD wallet, sometimes referred to as a “legacy” wallet. It follows the Bip39 standard for generation via menmonic.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class RegularWallet : Wallet
    +
    extension RegularWallet: Equatable
    +
    extension RegularWallet: Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Token + +
    +
    +
    +
    +
    +
    +

    A class to represent a Token on the Tezos network. This class will do all the heavy lifting of converting values from the RPC to more human readbale values. +This class will also handle arithmetic functions, allowing developers to add and subtract tokens (useful when caluclating fees and total values).

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class Token : Codable, CustomStringConvertible
    +
    extension Token: Equatable
    +
    extension Token: Hashable
    +
    extension Token: Identifiable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TokenAmount + +
    +
    +
    +
    +
    +
    +

    Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length. +This class is used to encapsulate a BigInt and provide all the necessary init’s and formatting functions to work with the networks requirements.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TokenAmount : Codable
    +
    extension TokenAmount: Comparable
    +
    extension TokenAmount: Equatable
    +
    extension TokenAmount: CustomStringConvertible
    +
    extension TokenAmount: Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TorusWallet + +
    +
    +
    +
    +
    +
    +

    A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

    + +

    This wallet is a subclass of LinearWallet created by using the Torus network to generate wallets from social media accounts. +This class is equivalent to a LinearWallet producing a TZ2 address via secp256k1, without the use of a mnemonic, and instead including the social profile of the user.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TorusWallet : RegularWallet
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + XTZAmount + +
    +
    +
    +
    +
    +
    +

    A subclass of TokenAmount to make it more explict when functions require XTZ (such as network fees). +It also serves as a means to more quickly create TokenAmount‘s conforming to XTZ.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class XTZAmount : TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DAppHelperService + +
    +
    +
    +
    +
    +
    +

    A Helper service to simply combine multiple calls from other services, and/or map to specific responses, in order to expose a piece of functionality provided by a dApp

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class DAppHelperService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DexCalculationService + +
    +
    +
    +
    +
    +
    +

    Wrapper around the kukai-dex-calculations JS library for performing calculations: https://github.com/kukai-wallet/kukai-dex-calculations

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class DexCalculationService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DiskService + +
    +
    +
    +
    +
    +
    +

    A service class to write and read data from the devices documents directory

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class DiskService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Service class +

+
+
+
    +
  • +
    + + + + ErrorHandlingService + +
    +
    +
    +
    +
    +
    +

    A class used to process errors into more readable format, and optionally notifiy a global error handler of every error occuring

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class ErrorHandlingService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FeeEstimatorService + +
    +
    +
    +
    +
    +
    +

    An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker. +This avoids the need to ask users to enter a fee, which is not a very user friendly approach as most users wouldn’t know what is required.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class FeeEstimatorService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LedgerService + +
    +
    +
    +
    +
    +
    +

    A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

    + +

    Ledger only provide a ReactNative module for third parties to integrate with. The architecture of the module also makes it very difficult to +integrate with native mobile (if it can be packaged up) as it relies heavily on long observable chains passing through many classes and functions. +To overcome this, I copied the base logic from multiple ledgerjs classes into a single typescript file and split the functions up into more of a utility style class, where +each function returns a result, that must be passed into another function. This allowed the creation of a swift class to sit in the middle of these +functions and decide what to do with the responses.

    + +

    The modified typescript can be found in this file (under a fork of the main repo) https://github.com/simonmcl/ledgerjs/blob/native-mobile/packages/hw-app-tezos/src/NativeMobileTezos.ts . +The containing package also includes a webpack file, which will package up the typescript and its dependencies into mobile friendly JS file, which +needs to be included in the swift project. Usage of the JS can be seen below.

    + +

    NOTE: this modified typescript is Tezos only as I was unable to find a way to simply subclass their Transport class, to produce a re-usable +NativeMobile transport. The changes required modifiying the app and other class logic which became impossible to refactor back into the project, without rewriting everything.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class LedgerService : NSObject, CBPeripheralDelegate, CBCentralManagerDelegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + MediaProxyService + +
    +
    +
    +
    +
    +
    +

    A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class MediaProxyService : NSObject
    +
    extension MediaProxyService: URLSessionDownloadDelegate
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class ContentTypeCheckingImageDownloader : ImageDownloader
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NetworkService + +
    +
    +
    +
    +
    +
    +

    Class responsible for sending all the networking requests, checking for http errors, RPC errors, Decoding the responses and optionally logging progress

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class NetworkService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationService + +
    +
    +
    +
    +
    +
    +

    Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class OperationService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TaquitoService + +
    +
    +
    +
    +
    +
    +

    Taquito (https://github.com/ecadlabs/taquito) is a popular open source Tezos library written in Typescript and Javascript. +Taquito is made up of many separate packages that deal with various aspects of Tezos RPC and Michelson. +This serivce class is a wrapper around a small piece of the Taquito library to expose funtionality that would otherwise be time consuming/risky/dangerous to re-implement natively. +The JS can now be found on each github release here: https://github.com/ecadlabs/taquito/releases/, by extracting the zip named “taquito-local-forging-vanilla.zip”

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TaquitoService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + TorusAuthService + +
    +
    +
    +
    +
    +
    +

    TorusAuthService is a wrapper around the SDK provided by: https://tor.us/ to allow the creation of TorusWallet‘s. +This allows users to create a wallet from their social media accounts without having to use a seed phrase / mnemonic. +TorusAuthService allows Tezos apps to leverage this service for a number of providers, and also has the ability to query the network for someone else’s wallet address, +based on their social profile. This allows you to send XTZ or tokens to your friend based on their twitter username for example

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class TorusAuthService : NSObject
    +
    extension TorusAuthService: ASAuthorizationControllerDelegate, ASAuthorizationControllerPresentationContextProviding
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + WalletCacheService + +
    +
    +
    +
    +
    +
    +

    A service class used to store and retrieve Wallet objects such as RegularWallet, HDWallet, LedgerWallet and TorusWallet from the devices disk. +This class will use the secure enclave (keychain if not available) to generate a key used to encrypt the contents locally, and retrieve. +This class will also store non senstiivve “metadata” about wallets, to allow storage of UI related data users might want to add, without cluttering up the wallet objects themselves

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class WalletCacheService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/BetterCallDevClient.html b/docsets/.docset/Contents/Resources/Documents/Classes/BetterCallDevClient.html new file mode 100644 index 00000000..9e998e2f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/BetterCallDevClient.html @@ -0,0 +1,913 @@ + + + + BetterCallDevClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevClient

+
+
+ +
public class BetterCallDevClient
+ +
+
+

BetterCallDev (BCD) is an indexer/smart contract debugging tool, used for the Tezos blockchain. +This class allows developers to interact with their API, to fetch data that would otherwise be impossible for a mobile app to fetch from the Tezos RPC

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Dedicated BCD errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum BetterCallDevClientError : Error
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Errors +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Primarily the TzKTClient is used to fetch details on operations. However for more complex calls involving smart contracts, TzKT will only return limited error message info. +BetterCallDev includles all the details needed to display messages. This function allows developers to query the detailed error message.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getMoreDetailedError(byHash hash: String, completion: @escaping ((BetterCallDevOperationError?, KukaiError?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + byHash + + +
    +

    The hash String of the operation.

    +
    +
    + + completion + + +
    +

    Called with the result.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/BetterCallDevClient/BetterCallDevClientError.html b/docsets/.docset/Contents/Resources/Documents/Classes/BetterCallDevClient/BetterCallDevClientError.html new file mode 100644 index 00000000..3bc038f4 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/BetterCallDevClient/BetterCallDevClientError.html @@ -0,0 +1,793 @@ + + + + BetterCallDevClientError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevClientError

+
+
+ +
public enum BetterCallDevClientError : Error
+ +
+
+

Dedicated BCD errors

+ +
+
+
+
    +
  • +
    + + + + invalidURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidURL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseError(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parseError(String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/BetterCallDevTokenMetadata.html b/docsets/.docset/Contents/Resources/Documents/Classes/BetterCallDevTokenMetadata.html new file mode 100644 index 00000000..89fc4b51 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/BetterCallDevTokenMetadata.html @@ -0,0 +1,949 @@ + + + + BetterCallDevTokenMetadata Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevTokenMetadata

+
+
+ +
public class BetterCallDevTokenMetadata : Codable
+ +
+
+

A model matching the response that comes back from BetterCallDev’s API: v1/tokens/<network>/metadata?contract=<address>

+ +
+
+
+
    +
  • +
    + + + + contract + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contract: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + network + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let network: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + token_id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token_id: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimals + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let decimals: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + faVersion + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var faVersion: FaVersion?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + imageURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var imageURL: URL?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/ContentTypeCheckingImageDownloader.html b/docsets/.docset/Contents/Resources/Documents/Classes/ContentTypeCheckingImageDownloader.html new file mode 100644 index 00000000..aa445f17 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/ContentTypeCheckingImageDownloader.html @@ -0,0 +1,766 @@ + + + + ContentTypeCheckingImageDownloader Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ContentTypeCheckingImageDownloader

+
+
+ +
public class ContentTypeCheckingImageDownloader : ImageDownloader
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func startDownloadTask(context: DownloadingContext, callback: SessionDataTask.TaskCallback) -> DownloadTask
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/DAppHelperService.html b/docsets/.docset/Contents/Resources/Documents/Classes/DAppHelperService.html new file mode 100644 index 00000000..2091d82c --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/DAppHelperService.html @@ -0,0 +1,769 @@ + + + + DAppHelperService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DAppHelperService

+
+
+ +
public class DAppHelperService
+ +
+
+

A Helper service to simply combine multiple calls from other services, and/or map to specific responses, in order to expose a piece of functionality provided by a dApp

+ +
+
+
+
    +
  • +
    + + + + Quipuswap + +
    +
    +
    +
    +
    +
    +

    All functions related to Quipuswap

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Quipuswap
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/DAppHelperService/Quipuswap.html b/docsets/.docset/Contents/Resources/Documents/Classes/DAppHelperService/Quipuswap.html new file mode 100644 index 00000000..738d0b34 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/DAppHelperService/Quipuswap.html @@ -0,0 +1,952 @@ + + + + Quipuswap Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Quipuswap

+
+
+ +
public struct Quipuswap
+ +
+
+

All functions related to Quipuswap

+ +
+
+
+
+ + +
+ +

Quipuswap Constants +

+
+
+ +
+
+
+ + +
+ +

Quipuswap Functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Use TzKTClient’s methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getPendingRewards(fromExchange exchange: String, forAddress address: String, tzKTClient: TzKTClient, completion: @escaping ((Result<XTZAmount, KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper around getPendingRewards(..., completion: ) to make it easier to create bulk queries, through combine

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getPendingRewards(fromExchange exchange: String, forAddress address: String, tzKTClient: TzKTClient) -> Future<(exchange: String, rewards: XTZAmount), KukaiError>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Use TzKTClient’s methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getBulkPendingRewards(fromExchanges exchanges: [String], forAddress address: String, tzKTClient: TzKTClient, completion: @escaping ((Result<[(exchange: String, rewards: XTZAmount)], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/DexCalculationService.html b/docsets/.docset/Contents/Resources/Documents/Classes/DexCalculationService.html new file mode 100644 index 00000000..a65d53e5 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/DexCalculationService.html @@ -0,0 +1,2808 @@ + + + + DexCalculationService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DexCalculationService

+
+
+ +
public class DexCalculationService
+ +
+
+

Wrapper around the kukai-dex-calculations JS library for performing calculations: https://github.com/kukai-wallet/kukai-dex-calculations

+ +
+
+
+
    +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Public shared instace to avoid having multiple copies of the underlying JSContext created

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let shared: DexCalculationService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

User flow functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for a xtzToToken exchange, to perform the operation and display the info to the user in a confirmation screen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateXtzToToken(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexSwapCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex contract holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex contract holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    DexSwapCalculationResult containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for a tokenToXtz exchange, to perform the operation and display the info to the user in a confirmation screen.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateTokenToXTZ(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexSwapCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex contract holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex contract holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    DexSwapCalculationResult containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for adding liquidity, with an XTZ input

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateAddLiquidity(xtz: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, totalLiquidity: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexAddCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + xtz + + +
    +

    The amount of XTZ to deposit

    +
    +
    + + xtzPool + + +
    +

    The total XTZ held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The total token held in the dex contract

    +
    +
    + + totalLiquidity + + +
    +

    The ttotal liquidity held in the liquidity contract

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    (tokenRequired: TokenAmount, liquidity: TokenAmount) containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for adding liquidity, with an Token input

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateAddLiquidity(token: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, totalLiquidity: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexAddCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + token + + +
    +

    The amount of Token to deposit

    +
    +
    + + xtzPool + + +
    +

    The total XTZ held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The total token held in the dex contract

    +
    +
    + + totalLiquidity + + +
    +

    The ttotal liquidity held in the liquidity contract

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    (xtzRequired: XTZAmount, liquidity: TokenAmount) containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A helper function to create all the necessary calculations for removing liquidity, to return everything the user will get out

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func calculateRemoveLiquidity(liquidityBurned: TokenAmount, totalLiquidity: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, maxSlippage: Double, dex: DipDupExchangeName) -> DexRemoveCalculationResult?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + liquidityBurned + + +
    +

    The amount of Liquidity tokens the user wants to burn or sell

    +
    +
    + + totalLiquidity + + +
    +

    The total volume of liquidity held in the contract

    +
    +
    + + xtzPool + + +
    +

    The xtz pool held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The token pool held in the dex contract

    +
    +
    + + maxSlippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    (xtz: XTZAmount, token: TokenAmount) containing the results of all the necessary calculations.

    +
    +
    +
    +
  • +
  • +
    + + + + settings(forDex:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func settings(forDex dex: DipDupExchangeName) -> (fee: Double, burn: Double, includeSubsidy: Bool)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

XTZ To Token +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The TokenAmount expected to be returned for the supplied XTZAmount, given the dex contract xtzPool and tokenPool.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenExpectedReturn(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> TokenAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount containing the amount the user can expect in return for their XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The minimum possible TokenAmount returned, taking into account slippage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenMinimumReturn(tokenAmount: TokenAmount, slippage: Double) -> TokenAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + tokenAmount + + +
    +

    The TokenAmount returned from xtzToTokenExpectedReturn().

    +
    +
    + + slippage + + +
    +

    A double value between 0 and 1, indicating the maximum percentage of slippage a user will accept.

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount containing the minimum amount the user can expect in return for their XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the XTZAmount required in order to receive the supplied TokenAmount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenRequiredXtzFor(tokenAmount: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> XTZAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenAmount + + +
    +

    The TokenAmount the user wants to receive.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount containing the amount of XTZ required in order to recieve the amount of token.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

XTZ To Token Rates +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The exchange rate for a given trade, taking into account slippage and fees

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenExchangeRate(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 XTZ to the requested Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenExchangeRateDisplay(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 XTZ to the requested Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenMarketRate(xtzPool: XTZAmount, tokenPool: TokenAmount) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 XTZ to the requested Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calcualte the percentage the price impact the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzToTokenPriceImpact(xtzToSell: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToSell + + +
    +

    The XTZAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the slippage percentage, 0 - 100.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Token to XTZ +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The XTZAmount expected to be returned for the supplied TokenAmount, given the dex contracts xtzPool and tokenPool.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzExpectedReturn(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> XTZAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount containing the amount the user can expect in return for their Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The minimum possible XTZAmount returned, taking into account slippage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzMinimumReturn(xtzAmount: XTZAmount, slippage: Double) -> XTZAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + xtzAmount + + +
    +

    The XTZAmount returned from tokenToXtzExpectedReturn().

    +
    +
    + + slippage + + +
    +

    A double value between 0 and 1, indicating the maximum percentage of slippage a user will accept.

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount containing the minimum amount the user can expect in return for their Token

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the TokenAmount required in order to receive the supplied XTZAmount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzRequiredTokenFor(xtzAmount: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> TokenAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzAmount + + +
    +

    The XTZAmount the user wants to receive.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount containing the amount of Token required in order to recieve the amount of XTZ.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

XTZ To Token Rates +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The exchange rate for a given trade, taking into account slippage and fees

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzExchangeRate(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 of the given Token to XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzExchangeRateDisplay(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 of the given Token to XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzMarketRate(xtzPool: XTZAmount, tokenPool: TokenAmount) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the exchange rate from 1 of the given Token to XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calcualte the percentage slippage the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenToXtzPriceImpact(tokenToSell: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToSell + + +
    +

    The TokenAmount to sell.

    +
    +
    + + xtzPool + + +
    +

    The XTZAmount representing the current pool of XTZ that the dex holds. Can be fetched with xxxxx.

    +
    +
    + + tokenPool + + +
    +

    The TokenAmount representing the current pool of the given Token that the dex holds. Must have the same number of decimalPlaces as the token it represents. Can be fetched with xxxxx.

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal containing the slippage percentage, 0 - 100.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Add Liquidity +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of liquidity tokens a user can expect back for an amount of XTZ and Token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func addLiquidityReturn(xtzToDeposit: XTZAmount, xtzPool: XTZAmount, totalLiquidity: TokenAmount, slippage: Double, dex: DipDupExchangeName) -> (expected: TokenAmount, minimum: TokenAmount)?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + xtzToDeposit + + +
    +

    The XTZ to send to the dex contract

    +
    +
    + + tokenToDeposit + + +
    +

    The Token to send to the dex contract

    +
    +
    + + totalLiquidity + + +
    +

    The total liquidity already in the contract

    +
    +
    + + slippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount an amount of Liquidity token you will receive

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of Token that is required to send along side your XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func addLiquidityTokenRequired(xtzToDeposit: XTZAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> TokenAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + xtzToDeposit + + +
    +

    The amount of XTZ to send

    +
    +
    + + xtzPool + + +
    +

    The XTZ currently held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The Token currently held in the dex contract

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount The amount of token required to send with the given amount of XTZ

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of XTZ that is required to send along side your Token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func addLiquidityXtzRequired(tokenToDeposit: TokenAmount, xtzPool: XTZAmount, tokenPool: TokenAmount, dex: DipDupExchangeName) -> XTZAmount?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tokenToDeposit + + +
    +

    The amount of Token to send

    +
    +
    + + xtzPool + + +
    +

    The XTZ currently held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The Token currently held in the dex contract

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount The amount of XTZ required to send with the given amount of Token

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Remove Liquidity +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of token a user would revice back if they burned X liquidity

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func removeLiquidityTokenReceived(liquidityBurned: TokenAmount, totalLiquidity: TokenAmount, tokenPool: TokenAmount, slippage: Double) -> (expected: TokenAmount, minimum: TokenAmount)?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + liquidityBurned + + +
    +

    The amount of liquidity to burn

    +
    +
    + + totalLiquidity + + +
    +

    The totla liquidity held in the dex contract

    +
    +
    + + tokenPool + + +
    +

    The total token held in the dex contract

    +
    +
    + + slippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    TokenAmount The amount of Token that would be returned

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the amount of XTZ a user would revice back if they burned X liquidity

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func removeLiquidityXtzReceived(liquidityBurned: TokenAmount, totalLiquidity: TokenAmount, xtzPool: XTZAmount, slippage: Double, dex: DipDupExchangeName) -> (expected: XTZAmount, minimum: XTZAmount)?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + liquidityBurned + + +
    +

    The amount of liquidity to burn

    +
    +
    + + totalLiquidity + + +
    +

    The totla liquidity held in the dex contract

    +
    +
    + + xtzPool + + +
    +

    The total XTZ held in the dex contract

    +
    +
    + + slippage + + +
    +

    Percentage (must be between 0 and 1) of maximum amount of slippage the user is willing to accept

    +
    +
    +
    +
    +

    Return Value

    +

    XTZAmount The amount of XTZ that would be returned

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Misc +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Estimate the APY of liquidity baking contract, as it has a known income.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func estimateLiquidityBakingAPY(xtzPool: XTZAmount) -> Decimal?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + xtzPool + + +
    +

    The total XTZ held in the dex contract

    +
    +
    +
    +
    +

    Return Value

    +

    Decimal The estimated percentage APY

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/DipDupClient.html b/docsets/.docset/Contents/Resources/Documents/Classes/DipDupClient.html new file mode 100644 index 00000000..6f7487bb --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/DipDupClient.html @@ -0,0 +1,1085 @@ + + + + DipDupClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupClient

+
+
+ +
public class DipDupClient
+ +
+
+

This client exposes functions to allow communication to the indexer platform DipDup ( https://dipdup.net/ ). +DipDup is composed of many small, dedicated indexers, powered by GraphQL. This client tries to exposes userflow functions, allowing users to accomplish tasks without having to worry about the underlying complexities

+ +
+
+
+
    +
  • +
    + + + + dexMaxQuerySize + +
    +
    +
    +
    +
    +
    +

    Max enteries to return per request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let dexMaxQuerySize: Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Public functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get a list of all the tokens available and on what excahnges (including their prices and pool data)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getExchangesAndTokens(limit: Int = DipDupClient.dexMaxQuerySize, offset: Int = 0, completion: @escaping ((Result<GraphQLResponse<DipDupExchangesAndTokensResponse>, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + limit + + +
    +

    Int, How many results to reuturn 100 Max)

    +
    +
    + + offset + + +
    +

    Int, How many positions to move the cursor

    +
    +
    + + completion + + +
    +

    Block returning a GraphQL response or an KukaiError

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Recurrsively call getExchangesAndTokens(...) until we have found all the tokens

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAllExchangesAndTokens(completion: @escaping ((Result<[DipDupExchangesAndTokens], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    Block returning a GraphQL response or an KukaiError

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Query a given addresses liquidity token balances

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getLiquidityFor(address: String, completion: @escaping ((Result<GraphQLResponse<DipDupPosition>, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + address + + +
    +

    The TZ address to query for

    +
    +
    + + completion + + +
    +

    Block returning a GraphQL response or an KukaiError

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Query a given contract address for pricing data for the given token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getChartDataFor(exchangeContract: String, nowDate: Date = Date(), completion: @escaping ((Result<GraphQLResponse<DipDupChartData>, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + exchangeContract + + +
    +

    The KT address of the dex contract to query data for

    +
    +
    + + completion + + +
    +

    Block returning a GraphQL response or an KukaiError

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/DiskService.html b/docsets/.docset/Contents/Resources/Documents/Classes/DiskService.html new file mode 100644 index 00000000..6640f575 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/DiskService.html @@ -0,0 +1,1051 @@ + + + + DiskService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DiskService

+
+
+ +
public class DiskService
+ +
+
+

A service class to write and read data from the devices documents directory

+ +
+
+
+
+ + +
+ +

Write +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Write an instance of Data to a given fileName

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func write(data: Data, toFileName: String, isExcludedFromBackup: Bool = true) -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the operation was successful

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Write an instance of an object conforming to Encodable to a fileName

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func write<T>(encodable: T, toFileName: String, isExcludedFromBackup: Bool = true) -> Bool where T : Encodable
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the operation was successful

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Read +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Read a fileName and return the contents as Data

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func readData(fromFileName: String) -> Data?
    + +
    +
    +
    +

    Return Value

    +

    Data, if able to read file

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Read a fileName, and parse the contents as an instance of a Decodable object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func read<T>(type: T.Type, fromFileName: String) -> T? where T : Decodable
    + +
    +
    +
    +

    Return Value

    +

    An instance of the Decodable type, if able to read file and parse it

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Delete +

+
+
+
    +
  • +
    + + + + delete(fileName:) + +
    +
    +
    +
    +
    +
    +

    Delete a fileName

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func delete(fileName: String) -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the operation was successful

    +
    +
    +
    +
  • +
  • +
    + + + + delete(fileNames:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func delete(fileNames: [String]) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Utility +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get the URL to the devices documents directory, if possible

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func documentsDirectory(isExcludedFromBackup: Bool = true) -> URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exists(fileName:) + +
    +
    +
    +
    +
    +
    +

    Check if a fileName exists in the documents directory or not

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func exists(fileName: String) -> URL?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Find all files in documents directory begining with prefix

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func allFileNamesWith(prefix: String) -> [String]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/ErrorHandlingService.html b/docsets/.docset/Contents/Resources/Documents/Classes/ErrorHandlingService.html new file mode 100644 index 00000000..112a05b0 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/ErrorHandlingService.html @@ -0,0 +1,925 @@ + + + + ErrorHandlingService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ErrorHandlingService

+
+
+ +
public class ErrorHandlingService
+ +
+
+

A class used to process errors into more readable format, and optionally notifiy a global error handler of every error occuring

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Shared instance so that it can hold onto an event closure

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let shared: ErrorHandlingService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errorEventClosure + +
    +
    +
    +
    +
    +
    +

    Called everytime an error is parsed. Extremely useful to track / log errors globally, in order to run logic or record to external service

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var errorEventClosure: ((KukaiError) -> Void)?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Error parsers +

+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService.html b/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService.html new file mode 100644 index 00000000..acda85ea --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService.html @@ -0,0 +1,1360 @@ + + + + FeeEstimatorService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FeeEstimatorService

+
+
+ +
public class FeeEstimatorService
+ +
+
+

An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker. +This avoids the need to ask users to enter a fee, which is not a very user friendly approach as most users wouldn’t know what is required.

+ +
+
+
+
    +
  • +
    + + + + defaultSignature + +
    +
    +
    +
    +
    +
    +

    The real signature is not needed for estimation, use the default “Zero Signature” instead

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let defaultSignature: [UInt8]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + defaultSignatureHex + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let defaultSignatureHex: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + FeeConstants + +
    +
    +
    +
    +
    +
    +

    Constants needed to compute a fee

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct FeeConstants
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Various possible errors that can occur during an Estimation

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum FeeEstimatorServiceError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EstimationResult + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct EstimationResult : Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + config + +
    +
    +
    +
    +
    +
    +

    The configuration object containing all the necessary settings to connect and communicate with the Tezos node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let config: TezosNodeClientConfig
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationService + +
    +
    +
    +
    +
    +
    +

    The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operationService: OperationService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkService + +
    +
    +
    +
    +
    +
    +

    The NetworkService that will handle the remote communication.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let networkService: NetworkService
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a FeeEstimatorService that will allow developers to automatically create fees on the users behalf

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(config: TezosNodeClientConfig = TezosNodeClientConfig(withDefaultsForNetworkType: .mainnet), operationService: OperationService, networkService: NetworkService)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + operationService + + +
    +

    The OperationService used to perform the forging.

    +
    +
    + + networkService + + +
    +

    The NetworkService that will handle the remote communication.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Pass in an array of Operation subclasses (use OperationFacotry to create) to have the library estimate the cost of sending the transaction. Function will use local or remote forging based off config passed in. +If the supplied operations contain suggested fees (e.g. from a dApp) this function will estimate the fee and pick which ever is higher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func estimate(operations: [Operation], operationMetadata: OperationMetadata, constants: NetworkConstants, walletAddress: String, base58EncodedPublicKey: String, completion: @escaping ((Result<EstimationResult, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + operations + + +
    +

    An array of Operation subclasses to be estimated.

    +
    +
    + + operationMetadata + + +
    +

    An OperationMetadata object containing necessary info about the current blockchain state.

    +
    +
    + + networkConstants + + +
    +

    A NetworkConstants used to provide information about the current network requirements.

    +
    +
    + + withWallet + + +
    +

    The Wallet object used for signing the transaction.

    +
    +
    + + completion + + +
    +

    A callback containing the same operations passed in, modified to include fees.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an array of OperationFees from an OperationResponse.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func extractFees(fromOperationResponse operationResponse: OperationResponse, forgedHash: String, withConstants constants: NetworkConstants) -> [OperationFees]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + fromOperationResponse + + +
    +

    The OperationResponse resulting from an RPC call to .../run_operation.

    +
    +
    + + forgedHash + + +
    +

    The forged hash string resulting from a call to TezosNodeClient.forge(...)

    +
    +
    +
    +
    +

    Return Value

    +

    An array of OperationFees

    +
    +
    +
    +
  • +
  • +
    + + + + feeForGas(_:) + +
    +
    +
    +
    +
    +
    +

    Calculate the fee to add for the given amount of gas

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func feeForGas(_ gas: Int) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the fee to add based on the size of the forged string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func feeForStorage(_ forgedHexString: String, numberOfOperations: Int) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Calculate the fee to add based on how many bytes of storage where needed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func feeForBurn(_ burn: Int, withConstants contants: NetworkConstants) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nanoTeztoXTZ(_:) + +
    +
    +
    +
    +
    +
    +

    Most calcualtions are documented in NanoTez, which is not accpeted by the network RPC calls. Needs to be converted to Mutez / XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func nanoTeztoXTZ(_ nanoTez: NanoTez) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func fee(forGasLimit gasLimit: Int, forgedHexString: String, numberOfOperations: Int) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func addGasSafetyMarginTo(gasUsed: Int) -> Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService/EstimationResult.html b/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService/EstimationResult.html new file mode 100644 index 00000000..c715cd63 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService/EstimationResult.html @@ -0,0 +1,792 @@ + + + + EstimationResult Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

EstimationResult

+
+
+ +
public struct EstimationResult : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + operations + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operations: [Operation]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + forgedString + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let forgedString: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService/FeeConstants.html b/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService/FeeConstants.html new file mode 100644 index 00000000..1ac465c7 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService/FeeConstants.html @@ -0,0 +1,871 @@ + + + + FeeConstants Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FeeConstants

+
+
+ +
public struct FeeConstants
+ +
+
+

Constants needed to compute a fee

+ +
+
+
+
    +
  • +
    + + + + nanoTezPerMutez + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let nanoTezPerMutez: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + minimalFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let minimalFee: NanoTez
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + feePerGasUnit + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let feePerGasUnit: NanoTez
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + feePerStorageByte + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let feePerStorageByte: NanoTez
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + baseFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let baseFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService/FeeEstimatorServiceError.html b/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService/FeeEstimatorServiceError.html new file mode 100644 index 00000000..f2385821 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/FeeEstimatorService/FeeEstimatorServiceError.html @@ -0,0 +1,897 @@ + + + + FeeEstimatorServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FeeEstimatorServiceError

+
+
+ +
public enum FeeEstimatorServiceError : Error
+ +
+
+

Various possible errors that can occur during an Estimation

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/HDWallet.html b/docsets/.docset/Contents/Resources/Documents/Classes/HDWallet.html new file mode 100644 index 00000000..bf096c5b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/HDWallet.html @@ -0,0 +1,1272 @@ + + + + HDWallet Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

HDWallet

+
+
+ +
public class HDWallet : Wallet
+
extension HDWallet: Equatable
+
extension HDWallet: Hashable
+ +
+
+

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

+ +

This wallet is a HD wallet, allowing the creation of many child wallets from the one base privateKey. It also follows the Bip39 stnadard for generation via a mnemonic.

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The underlying wallet type, set to .hd

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: WalletType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The public TZ1 address of the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKey + +
    +
    +
    +
    +
    +
    +

    An WalletCore object representing the PrivateKey used to generate the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var privateKey: PrivateKey
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    +

    An WalletCore object representing the PublicKey used to generate the wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var publicKey: PublicKey
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mnemonic + +
    +
    +
    +
    +
    +
    +

    The Bip39 mnemonic used to generate the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var mnemonic: Mnemonic
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + derivationPath + +
    +
    +
    +
    +
    +
    +

    The Bip44 derivationPath used to create the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var derivationPath: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a HDWallet by supplying a mnemonic string and a passphrase (or “” if none).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(withMnemonic mnemonic: Mnemonic, passphrase: String, derivationPath: String = HD.defaultDerivationPath)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + withMnemonic + + +
    +

    A Mnemonic representing a BIP39 menmonic

    +
    +
    + + passphrase + + +
    +

    String contianing a passphrase, or empty string if none

    +
    +
    + + derivationPath + + +
    +

    Optional: use a different derivation path to the default HDWallet.defaultDerivationPath

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a HDWallet by asking for a mnemonic of a given number of words and a passphrase (or “” if none).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(withMnemonicLength length: Mnemonic.NumberOfWords, passphrase: String, derivationPath: String = HD.defaultDerivationPath)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + withMnemonicLength + + +
    +

    Mnemonic.NumberOfWords the number of words to use when creating a mnemonic

    +
    +
    + + passphrase + + +
    +

    String contianing a passphrase, or empty string if none

    +
    +
    + + derivationPath + + +
    +

    Optional: use a different derivation path to the default HDWallet.defaultDerivationPath

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Crypto Functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Sign a hex payload with the private key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKeyCurve() + +
    +
    +
    +
    +
    +
    +

    Return the curve used to create the key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func privateKeyCurve() -> EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a Base58 encoded version of the public key, in order to reveal the address on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func publicKeyBase58encoded() -> String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The default implementation in Ledger is to not give users the option to provide their own derivation path, but instead increment the “account” field by 1 each time. +This function will create a new HDWallet, by taking the default derivation path and changing the account to the index supplied, and using the same key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func createChild(accountIndex: Int) -> HDWallet?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    This function will create a new HDWallet, by using the same key combined with the supplied derivationPath

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func createChild(derivationPath: String) -> HDWallet?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: HDWallet, rhs: HDWallet) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/LedgerService.html b/docsets/.docset/Contents/Resources/Documents/Classes/LedgerService.html new file mode 100644 index 00000000..e47bcac7 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/LedgerService.html @@ -0,0 +1,1456 @@ + + + + LedgerService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LedgerService

+
+
+ +
public class LedgerService : NSObject, CBPeripheralDelegate, CBCentralManagerDelegate
+ +
+
+

A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

+ +

Ledger only provide a ReactNative module for third parties to integrate with. The architecture of the module also makes it very difficult to +integrate with native mobile (if it can be packaged up) as it relies heavily on long observable chains passing through many classes and functions. +To overcome this, I copied the base logic from multiple ledgerjs classes into a single typescript file and split the functions up into more of a utility style class, where +each function returns a result, that must be passed into another function. This allowed the creation of a swift class to sit in the middle of these +functions and decide what to do with the responses.

+ +

The modified typescript can be found in this file (under a fork of the main repo) https://github.com/simonmcl/ledgerjs/blob/native-mobile/packages/hw-app-tezos/src/NativeMobileTezos.ts . +The containing package also includes a webpack file, which will package up the typescript and its dependencies into mobile friendly JS file, which +needs to be included in the swift project. Usage of the JS can be seen below.

+ +

NOTE: this modified typescript is Tezos only as I was unable to find a way to simply subclass their Transport class, to produce a re-usable +NativeMobile transport. The changes required modifiying the app and other class logic which became impossible to refactor back into the project, without rewriting everything.

+ +
+
+
+
+ + +
+ +

Types / Constants +

+
+
+
    +
  • +
    + + + + successCode + +
    +
    +
    +
    +
    +
    +

    Instead of returning data, sometimes ledger returns a code to indicate that so far the message have been received successfully

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let successCode: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + GeneralErrorCodes + +
    +
    +
    +
    +
    +
    +

    General Ledger error codes, pulled from the source, and some additional ones added for native swift issues

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum GeneralErrorCodes : String, Error, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosAppErrorCodes + +
    +
    +
    +
    +
    +
    +

    Dedicated error codes pulled from the Ledger tezos app

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TezosAppErrorCodes : String, Error, Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Be notified when the ledger device returns a success message, part way through the process. +This can be useful to indicate to users that the request has succeed, but s waiting on input on the Ledger device to continue

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    @Published
    +public var partialSuccessMessageReceived: Bool { get set }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Public shared instace to avoid having multiple copies of the underlying JSContext created

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let shared: LedgerService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public functions +

+
+
+
    +
  • +
    + + + + listenForDevices() + +
    +
    +
    +
    +
    +
    +

    Start listening for ledger devices

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func listenForDevices() -> AnyPublisher<[String : String], KukaiError>
    + +
    +
    +
    +

    Return Value

    +

    Publisher with a dictionary of [UUID: deviceName] or an KukaiError

    +
    +
    +
    +
  • +
  • +
    + + + + stopListening() + +
    +
    +
    +
    +
    +
    +

    Stop listening for and reporting new ledger devices found

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func stopListening()
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + connectTo(uuid:) + +
    +
    +
    +
    +
    +
    +

    Connect to a ledger device by a given UUID

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func connectTo(uuid: String) -> AnyPublisher<Bool, KukaiError>
    + +
    +
    +
    +

    Return Value

    +

    Publisher which will indicate true / false, or return an KukaiError if it can’t connect to bluetooth

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Disconnect from the current Ledger device

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func disconnectFromDevice()
    + +
    +
    +
    +

    Return Value

    +

    A Publisher with a boolean, or KukaiError if soemthing goes wrong

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the UUID of the connected device

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getConnectedDeviceUUID() -> String?
    + +
    +
    +
    +

    Return Value

    +

    a string if it can be found

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a TZ address and public key from the current connected Ledger device

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAddress(forDerivationPath derivationPath: String = HD.defaultDerivationPath, curve: EllipticalCurve = .ed25519, verify: Bool) -> AnyPublisher<(address: String, publicKey: String), KukaiError>
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + forDerivationPath + + +
    +

    Optional. The derivation path to use to extract the address from the underlying HD wallet

    +
    +
    + + curve + + +
    +

    Optional. The EllipticalCurve to use to extract the address

    +
    +
    + + verify + + +
    +

    Whether or not to ask the ledger device to prompt the user to show them what the TZ address should be, to ensure the mobile matches

    +
    +
    +
    +
    +

    Return Value

    +

    A publisher which will return a tuple containing the address and publicKey, or an KukaiError

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Sign an operation payload with the underlying secret key, returning the signature

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func sign(hex: String, forDerivationPath derivationPath: String = HD.defaultDerivationPath, parse: Bool) -> AnyPublisher<String, KukaiError>
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + hex + + +
    +

    An operation converted to JSON, forged and watermarked, converted to a hex string. (Note: there are some issues with the ledger app signing batch transactions. May simply return no result at all. Can’t run REVEAL and TRANSACTION together for example)

    +
    +
    + + forDerivationPath + + +
    +

    Optional. The derivation path to use to extract the address from the underlying HD wallet

    +
    +
    + + parse + + +
    +

    Ledger can parse non-hashed (blake2b) hex data and display operation data to user (e.g. transfer 1 XTZ to TZ1abc, for fee: 0.001). There are many limitations around what can be parsed. Frequnetly it will require passing in false

    +
    +
    +
    +
    +

    Return Value

    +

    A Publisher which will return a string containing the hex signature, or an KukaiError

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Bluetooth +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func centralManagerDidUpdateState(_ central: CBCentralManager)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func centralManager(_ central: CBCentralManager, didDiscover peripheral: CBPeripheral, advertisementData: [String : Any], rssi RSSI: NSNumber)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func centralManager(_ central: CBCentralManager, didConnect peripheral: CBPeripheral)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func centralManager(_ central: CBCentralManager, didFailToConnect peripheral: CBPeripheral, error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func peripheral(_ peripheral: CBPeripheral, didDiscoverServices error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func peripheral(_ peripheral: CBPeripheral, didDiscoverCharacteristicsFor service: CBService, error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func peripheral(_ peripheral: CBPeripheral, didWriteValueFor characteristic: CBCharacteristic, error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    CBCentralManagerDelegate function, must be marked public because of protocol definition

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func peripheral(_ peripheral: CBPeripheral, didUpdateValueFor characteristic: CBCharacteristic, error: Error?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/LedgerService/GeneralErrorCodes.html b/docsets/.docset/Contents/Resources/Documents/Classes/LedgerService/GeneralErrorCodes.html new file mode 100644 index 00000000..ed2fbe05 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/LedgerService/GeneralErrorCodes.html @@ -0,0 +1,1599 @@ + + + + GeneralErrorCodes Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

GeneralErrorCodes

+
+
+ +
public enum GeneralErrorCodes : String, Error, Codable
+ +
+
+

General Ledger error codes, pulled from the source, and some additional ones added for native swift issues

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case PIN_REMAINING_ATTEMPTS = "63c0"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INCORRECT_LENGTH + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INCORRECT_LENGTH = "6700"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case MISSING_CRITICAL_PARAMETER = "6800"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case COMMAND_INCOMPATIBLE_FILE_STRUCTURE = "6981"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case SECURITY_STATUS_NOT_SATISFIED = "6982"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CONDITIONS_OF_USE_NOT_SATISFIED = "6985"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INCORRECT_DATA + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INCORRECT_DATA = "6a80"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case NOT_ENOUGH_MEMORY_SPACE = "6a84"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case REFERENCED_DATA_NOT_FOUND = "6a88"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FILE_ALREADY_EXISTS + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case FILE_ALREADY_EXISTS = "6a89"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INCORRECT_P1_P2 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INCORRECT_P1_P2 = "6b00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INS_NOT_SUPPORTED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INS_NOT_SUPPORTED = "6d00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CLA_NOT_SUPPORTED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CLA_NOT_SUPPORTED = "6e00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TECHNICAL_PROBLEM + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case TECHNICAL_PROBLEM = "6f00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + MEMORY_PROBLEM + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case MEMORY_PROBLEM = "9240"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NO_EF_SELECTED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case NO_EF_SELECTED = "9400"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INVALID_OFFSET + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INVALID_OFFSET = "9402"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FILE_NOT_FOUND + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case FILE_NOT_FOUND = "9404"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INCONSISTENT_FILE + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INCONSISTENT_FILE = "9408"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ALGORITHM_NOT_SUPPORTED = "9484"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + INVALID_KCV + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case INVALID_KCV = "9485"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CODE_NOT_INITIALIZED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CODE_NOT_INITIALIZED = "9802"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ACCESS_CONDITION_NOT_FULFILLED = "9804"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CONTRADICTION_SECRET_CODE_STATUS = "9808"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CONTRADICTION_INVALIDATION = "9810"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CODE_BLOCKED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case CODE_BLOCKED = "9840"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + MAX_VALUE_REACHED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case MAX_VALUE_REACHED = "9850"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + GP_AUTH_FAILED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case GP_AUTH_FAILED = "6300"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LICENSING + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case LICENSING = "6f42"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + HALTED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case HALTED = "6faa"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DEVICE_LOCKED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case DEVICE_LOCKED = "009000"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + UNKNOWN + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case UNKNOWN = "99999999"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case NO_WRITE_CHARACTERISTIC = "99999996"
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/LedgerService/TezosAppErrorCodes.html b/docsets/.docset/Contents/Resources/Documents/Classes/LedgerService/TezosAppErrorCodes.html new file mode 100644 index 00000000..836b6c50 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/LedgerService/TezosAppErrorCodes.html @@ -0,0 +1,1053 @@ + + + + TezosAppErrorCodes Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosAppErrorCodes

+
+
+ +
public enum TezosAppErrorCodes : String, Error, Codable
+ +
+
+

Dedicated error codes pulled from the Ledger tezos app

+ +
+
+
+
    +
  • +
    + + + + EXC_WRONG_PARAM + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_WRONG_PARAM = "6B00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_WRONG_LENGTH + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_WRONG_LENGTH = "6C00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_INVALID_INS + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_INVALID_INS = "6D00"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_WRONG_LENGTH_FOR_INS = "917E"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_REJECT + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_REJECT = "6985"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_PARSE_ERROR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_PARSE_ERROR = "9405"
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_REFERENCED_DATA_NOT_FOUND = "6A88"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_WRONG_VALUES + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_WRONG_VALUES = "6A80"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_SECURITY + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_SECURITY = "6982"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_HID_REQUIRED + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_HID_REQUIRED = "6983"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_CLASS + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_CLASS = "6E00"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + EXC_MEMORY_ERROR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case EXC_MEMORY_ERROR = "9200"
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/LedgerWallet.html b/docsets/.docset/Contents/Resources/Documents/Classes/LedgerWallet.html new file mode 100644 index 00000000..df9ebdd7 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/LedgerWallet.html @@ -0,0 +1,1085 @@ + + + + LedgerWallet Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LedgerWallet

+
+
+ +
public class LedgerWallet : Wallet
+ +
+
+

A Tezos wallet class, used to cache infomration regarding the paired ledger device used to sign the payload. +This class can only be created by fetching data from a Ledger device and supplying this data to the constructor.

+ +

It is not possible to call the async sign function of this class, it will return null. Signing with a ledger is a complicated async process. +Please use the LedgerService class to setup a bluetooth connection, connect to the device and request a payload signing.

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The wallet type, hardcoded to always be WalletType.ledger

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var type: WalletType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The TZ address pulled from the Ledger device, cached to avoid complex retrieval when fetching balances etc.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    +

    The raw hex public key extracted from the Ledger, needed in order to perform REVEAL operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var publicKey: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + derivationPath + +
    +
    +
    +
    +
    +
    +

    The derivation path used to fetch the address and public key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var derivationPath: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + curve + +
    +
    +
    +
    +
    +
    +

    The elliptical curve used to fetch the address and public key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var curve: EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ledgerUUID + +
    +
    +
    +
    +
    +
    +

    The unique ledger UUID, that corresponds to this wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var ledgerUUID: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an instance of a LedgerWallet. Can return nil if invalid public key supplied

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(address: String, publicKey: String, derivationPath: String, curve: EllipticalCurve, ledgerUUID: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + address + + +
    +

    The TZ address pulled from the Ledger device

    +
    +
    + + publicKey + + +
    +

    The hex string denoting the public key, pulled from the ledger device

    +
    +
    + + derivationPath + + +
    +

    The derivation path used to fetch the address / publicKey

    +
    +
    + + curve + + +
    +

    The elliptical curve used to fetch the address / public key

    +
    +
    + + ledgerUUID + + +
    +

    The unique Ledger UUID to identify the Ledger

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Sign a hex string. +If the string starts with “03” and is not 32 characters long, it will be treated as a watermarked operation and Ledger will be asked to parse + display the operation details. +Else it will be treated as an unknown operation and will simply display the Blake2b hash. +Please be careful when asking the Ledger to parse (passing in an operation), Ledgers have very limited display ability. Keep it to a single operation, not invoking a smart contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKeyCurve() + +
    +
    +
    +
    +
    +
    +

    Function to extract the curve used to create the public key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func privateKeyCurve() -> EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Function to convert the public key into a Base58 encoded string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func publicKeyBase58encoded() -> String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService.html b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService.html new file mode 100644 index 00000000..bb88166c --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService.html @@ -0,0 +1,1750 @@ + + + + MediaProxyService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediaProxyService

+
+
+ +
public class MediaProxyService : NSObject
+
extension MediaProxyService: URLSessionDownloadDelegate
+ +
+
+

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

+ +
+
+
+
    +
  • +
    + + + + Format + +
    +
    +
    +
    +
    +
    +

    Enum denoting the avaialble sizes for media

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum Format : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Source + +
    +
    +
    +
    +
    +
    +

    Supported source types for proxied media

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum Source : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + MediaType + +
    +
    +
    +
    +
    +
    +

    Supported media types

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum MediaType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + AggregatedMediaType + +
    +
    +
    +
    +
    +
    +

    Helper to parse a collection of media types to understand its contents

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum AggregatedMediaType : String, Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

URL conversion +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Take a URI from a token metadata response and convert it to a useable media proxy URL

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func url(fromUriString uri: String?, ofFormat format: Format, keepGif: Bool = false) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + fromUriString + + +
    +

    String containing a URI (supports IPFS URIs)

    +
    +
    + + ofFormat + + +
    +

    The requested format from the proxy

    +
    +
    +
    +
    +

    Return Value

    +

    An optional URL

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Take a URI from a token metadata response and convert it to a useable media proxy URL

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func url(fromUri uri: URL?, ofFormat format: Format, keepGif: Bool = false) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + fromUri + + +
    +

    URL object containing a URI (supports IPFS URIs)

    +
    +
    + + ofFormat + + +
    +

    The requested format from the proxy

    +
    +
    +
    +
    +

    Return Value

    +

    An optional URL

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper method to return a standard thumbnail URL for a NFT, taking into account some custom logic / known workarounds

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func thumbnailURL(forNFT nft: NFT, keepGif: Bool = false) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNFT + + +
    +

    NFT object

    +
    +
    +
    +
    +

    Return Value

    +

    An optional URL

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper method to return a standard larger display URL for a NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func displayURL(forNFT nft: NFT, keepGif: Bool = false) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNFT + + +
    +

    NFT object

    +
    +
    +
    +
    +

    Return Value

    +

    An optional URL

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Type checking +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Using only info from TzKTBalanceMetadataFormat determine the media type(s) of the object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getMediaType(fromFormats formats: [TzKTBalanceMetadataFormat]) -> [MediaType]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Given multiple sources of information, attempt to find the media type the url is pointing too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getMediaType(fromFormats formats: [TzKTBalanceMetadataFormat], orURL url: URL?, urlSession: URLSession = .shared, completion: @escaping ((Result<[MediaType], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + fromFormats + + +
    +

    An array of TzKTBalanceMetadataFormat that comes down with the TzKTClient’s balancing fetching code. It MAY contain infomration on the media type

    +
    +
    + + orURL + + +
    +

    The URL for the record. It MAY contain a file extension dennoting the file type

    +
    +
    + + urlSession + + +
    +

    If type can’t be found via URL or metadata, download the first packet, examine the headers for Content-Type using this session. (HEAD requests aren’t currently supported if the asset hasn’t been already cached)

    +
    +
    + + completion + + +
    +

    A block to run when a type can be found, or an error encountered

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + typesContents(_:) + +
    +
    +
    +
    +
    +
    +

    Helper method to parse an array of MediaType to quickly determine its content type so UI can be easily arraged

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func typesContents(_ types: [MediaType]) -> AggregatedMediaType?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Cache management +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Clear all images from all caches

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func removeAllImages(completion: @escaping (() -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func removeAllImages(fromCache: CacheType, completion: @escaping (() -> Void))
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + clearExpiredImages() + +
    +
    +
    +
    +
    +
    +

    Clear only iamges from cahce that have expired

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func clearExpiredImages()
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + sizeOf(cache:) + +
    +
    +
    +
    +
    +
    +

    Get size in bytes

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sizeOf(cache: CacheType) -> UInt
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Image loading +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Attempt to use KingFisher library to load an image from a URL, into an UIImageView, with support for downsampling, displaying loading spinner, svgs, gifs and the permanent / temporary caching system

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func load(url: URL?, to imageView: UIImageView, withCacheType cacheType: CacheType, fallback: UIImage, downSampleSize: CGSize? = nil, completion: ((CGSize?) -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + url + + +
    +

    Media proxy URL pointing to an image

    +
    +
    + + to + + +
    +

    The UIImageView to load the image into

    +
    +
    + + fromCache + + +
    +

    Which cahce to search for the image, or load it into if not found and needs to be downloaded

    +
    +
    + + fallback + + +
    +

    If an error occurs and an image can’t be downloaded/loaded in, display this image instead

    +
    +
    + + downSampleSize + + +
    +

    Supply the dimensions you wish the image to be resized to fit

    +
    +
    + + completion + + +
    +

    returns when operation finished, if successful it will return the downloaded image’s CGSize

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + imageCache(forType:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func imageCache(forType: CacheType) -> ImageCache
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Attempt to use KingFisher library to load an image from a URL, and store it directly in the cache for later usage. Also optional return the downloaded size via a completion block, useful for preparing table/collection view

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func cacheImage(url: URL?, cacheType: CacheType = .temporary, completion: @escaping ((CGSize?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + url + + +
    +

    Media proxy URL pointing to an image

    +
    +
    + + fromCache + + +
    +

    Which cahce to search for the image, or load it into if not found and needs to be downloaded

    +
    +
    + + completion + + +
    +

    returns when operation finished, if successful it will return the downloaded image’s CGSize

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Check if a given url is already cached

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func isCached(url: URL?, cacheType: CacheType = .temporary) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Check if an image is cached, and return its size if so. Useful for preparing table/collection view

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sizeForImageIfCached(url: URL?, cacheType: CacheType = .temporary, completion: @escaping ((CGSize?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + url + + +
    +

    Media proxy URL pointing to an image

    +
    +
    + + fromCache + + +
    +

    Which cahce to search for the image, or load it into if not found and needs to be downloaded

    +
    +
    + + completion + + +
    +

    returns when operation finished, if successful it will return the downloaded image’s CGSize

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didFinishDownloadingTo location: URL)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func urlSession(_ session: URLSession, downloadTask: URLSessionDownloadTask, didWriteData bytesWritten: Int64, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/AggregatedMediaType.html b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/AggregatedMediaType.html new file mode 100644 index 00000000..6583b665 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/AggregatedMediaType.html @@ -0,0 +1,871 @@ + + + + AggregatedMediaType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

AggregatedMediaType

+
+
+ +
public enum AggregatedMediaType : String, Codable
+ +
+
+

Helper to parse a collection of media types to understand its contents

+ +
+
+
+
    +
  • +
    + + + + imageOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case imageOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + audioOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case audioOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + videoOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case videoOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + gifOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case gifOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + imageAndAudio + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case imageAndAudio
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/Format.html b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/Format.html new file mode 100644 index 00000000..f8c7c916 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/Format.html @@ -0,0 +1,871 @@ + + + + Format Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Format

+
+
+ +
public enum Format : String, Codable
+ +
+
+

Enum denoting the avaialble sizes for media

+ +
+
+
+
    +
  • +
    + + + + icon + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case icon
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + small + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case small
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + medium + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case medium
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + gallery + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case gallery
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + raw + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case raw
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/MediaType.html b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/MediaType.html new file mode 100644 index 00000000..13f75bef --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/MediaType.html @@ -0,0 +1,845 @@ + + + + MediaType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediaType

+
+
+ +
public enum MediaType : String, Codable
+ +
+
+

Supported media types

+ +
+
+
+
    +
  • +
    + + + + image + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case image
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + audio + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case audio
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + video + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case video
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + gif + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case gif
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/Source.html b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/Source.html new file mode 100644 index 00000000..2505845e --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/MediaProxyService/Source.html @@ -0,0 +1,793 @@ + + + + Source Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Source

+
+
+ +
public enum Source : String, Codable
+ +
+
+

Supported source types for proxied media

+ +
+
+
+
    +
  • +
    + + + + ipfs + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ipfs
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + web + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case web
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/NetworkService.html b/docsets/.docset/Contents/Resources/Documents/Classes/NetworkService.html new file mode 100644 index 00000000..afe2e54a --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/NetworkService.html @@ -0,0 +1,1267 @@ + + + + NetworkService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkService

+
+
+ +
public class NetworkService
+ +
+
+

Class responsible for sending all the networking requests, checking for http errors, RPC errors, Decoding the responses and optionally logging progress

+ +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + NetworkError + +
    +
    +
    +
    +
    +
    +

    Errors that can be returned by the NetworkService

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum NetworkError : Error
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + urlSession + +
    +
    +
    +
    +
    +
    +

    The URLSession used to preform all the networking operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let urlSession: URLSession
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + loggingConfig + +
    +
    +
    +
    +
    +
    +

    The URLSession used to preform all the networking operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let loggingConfig: LoggingConfig
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Init an NetworkService with a URLSession

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(urlSession: URLSession, loggingConfig: LoggingConfig)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + urlSession + + +
    +

    A URLSession object

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A generic send function that takes an RPC, with a generic type conforming to Decodable, executes the request and returns the result.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func send<T>(rpc: RPC<T>, withBaseURL baseURL: URL, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + rpc + + +
    +

    A instance of RPC.

    +
    +
    + + withBaseURL + + +
    +

    The base URL needed. This will typically come from TezosNodeConfig.

    +
    +
    + + completion + + +
    +

    A completion callback that will be executed on the main thread.

    +
    +
    +
    +
    +

    Return Value

    +

    Void

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response. +Using the Logging config, will auto log (or not) urls, response outputs, or fails to the console

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func request<T>(url: URL, isPOST: Bool, withBody body: Data?, forReturnType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + url + + +
    +

    The full url, including query parameters to execute.

    +
    +
    + + isPOST + + +
    +

    Bool indicating if its a POST or GET request.

    +
    +
    + + withBody + + +
    +

    Optional Data to be passed as the body.

    +
    +
    + + forReturnType + + +
    +

    The Type to parse the response as.

    +
    +
    + + completion + + +
    +

    A completion block with a Result<T, Error> T being the supplied decoable type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response, returning it as a combine publisher. +Using the Logging config, will auto log (or not) urls, response outputs, or fails to the console

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func request<T>(url: URL, isPOST: Bool, withBody body: Data?, forReturnType: T.Type) -> AnyPublisher<T, KukaiError> where T : Decodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + url + + +
    +

    The full url, including query parameters to execute.

    +
    +
    + + isPOST + + +
    +

    Bool indicating if its a POST or GET request.

    +
    +
    + + withBody + + +
    +

    Optional Data to be passed as the body.

    +
    +
    + + forReturnType + + +
    +

    The Type to parse the response as.

    +
    +
    +
    +
    +

    Return Value

    +

    A publisher of the supplied return type, or error response

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Logging +

+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/NetworkService/NetworkError.html b/docsets/.docset/Contents/Resources/Documents/Classes/NetworkService/NetworkError.html new file mode 100644 index 00000000..4aacc2a9 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/NetworkService/NetworkError.html @@ -0,0 +1,845 @@ + + + + NetworkError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkError

+
+
+ +
public enum NetworkError : Error
+ +
+
+

Errors that can be returned by the NetworkService

+ +
+
+
+
    +
  • +
    + + + + parse(error:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parse(error: String)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidURL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case httpError(statusCode: Int, response: String?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/ObjktClient.html b/docsets/.docset/Contents/Resources/Documents/Classes/ObjktClient.html new file mode 100644 index 00000000..628b51b8 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/ObjktClient.html @@ -0,0 +1,1042 @@ + + + + ObjktClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktClient

+
+
+ +
public class ObjktClient
+ +
+
+

Client for interacting with the API of the popular NFT marketplace, OBJKT.com +Client exposes functions for fetching metadata, pricing, purchase offers, listing etc

+ +
+
+
+
    +
  • +
    + + + + collections + +
    +
    +
    +
    +
    +
    +

    Cached metadata of NFT collections, e.g. name, thumbnailURL etc

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var collections: [String : ObjktCollection]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokens + +
    +
    +
    +
    +
    +
    +

    Cached metadata of specific tokens, e.g. prices, offers etc

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tokens: [String : ObjktTokenReponse]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Public single functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Take in an array of contract addresses, and return a list of the ones that we currently have no metadata for

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func unresolvedCollections(addresses: [String]) -> [String]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Search OBJKT to find metadata on the list of addresses provided

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func resolveCollectionsAll(addresses: [String], completion: @escaping ((Result<Bool, KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Find the metadata of a list of contracts, used recurrisvely to find all collections while limited to request query size

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func resolveCollectionsPage(addresses: ArraySlice<String>, completion: @escaping ((Result<GraphQLResponse<ObjktCollections>, KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Find the meatdata of a specific token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func resolveToken(address: String, tokenId: Decimal, forOwnerWalletAddress walletAddress: String, completion: @escaping ((Result<GraphQLResponse<ObjktTokenReponse>, KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper to fetch a specific token metadata from the cache

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenResponse(forAddress: String, tokenId: Int) -> ObjktTokenReponse?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + deleteCache() + +
    +
    +
    +
    +
    +
    +

    Clear all the cached data

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteCache()
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/Operation.html b/docsets/.docset/Contents/Resources/Documents/Classes/Operation.html new file mode 100644 index 00000000..f068a02f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/Operation.html @@ -0,0 +1,1049 @@ + + + + Operation Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Operation

+
+
+ +
public class Operation : Codable
+ +
+
+

Base class representing an Operation on the Tezos network. On its own this class can’t be sent to the network. See its subclasses for more info.

+ +
+
+
+
    +
  • +
    + + + + operationKind + +
    +
    +
    +
    +
    +
    +

    An enum to denote the type of operation. e.g. transaction, delegation, reveal etc.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operationKind: OperationKind
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + source + +
    +
    +
    +
    +
    +
    +

    The source address for the operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var source: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    +

    A string representing a numeric counter. Must be unique and 1 higher than the previous counter. Current counter obtained from the metadata query in TezosNodeClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var counter: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationFees + +
    +
    +
    +
    +
    +
    +

    Object representing the various fees, storage and compute required to fulfil this operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var operationFees: OperationFees
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(operationKind: OperationKind, source: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + operationKind + + +
    +

    The type of operation.

    +
    +
    + + source + + +
    +

    The address of the acocunt sending the operation.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: Operation) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationActivateAccount.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationActivateAccount.html new file mode 100644 index 00000000..53d08544 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationActivateAccount.html @@ -0,0 +1,993 @@ + + + + OperationActivateAccount Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationActivateAccount

+
+
+ +
public class OperationActivateAccount : Operation
+ +
+
+

Operation subclass for revealing a publickey to the network.

+ +
+
+
+
    +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let publicKey: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + secret + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let secret: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationActivateAccount.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, andSecret: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + wallet + + +
    +

    The Wallet object, whose publicKey will be used to activate on the network

    +
    +
    + + andSecret + + +
    +

    The secret supplied in JSON file

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationActivateAccount) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationBallot.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationBallot.html new file mode 100644 index 00000000..b4213373 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationBallot.html @@ -0,0 +1,955 @@ + + + + OperationBallot Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationBallot

+
+
+ +
public class OperationBallot : Operation
+ +
+
+

Operation to submit a ballot on an upcoming proposal

+ +
+
+
+
    +
  • +
    + + + + Ballot + +
    +
    +
    +
    +
    +
    +

    Enum matching the available ballot options

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum Ballot : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + period + +
    +
    +
    +
    +
    +
    +

    The voting period

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let period: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proposal + +
    +
    +
    +
    +
    +
    +

    The identifier of the proposa;

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let proposal: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ballot + +
    +
    +
    +
    +
    +
    +

    The wallet holders vote

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let ballot: Ballot
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init with wallet, period, proposal and ballot

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, period: Int, proposal: String, ballot: Ballot)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationBallot) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationBallot/Ballot.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationBallot/Ballot.html new file mode 100644 index 00000000..6fe8a0be --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationBallot/Ballot.html @@ -0,0 +1,819 @@ + + + + Ballot Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Ballot

+
+
+ +
public enum Ballot : String, Codable
+ +
+
+

Enum matching the available ballot options

+ +
+
+
+
    +
  • +
    + + + + nay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case nay
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + yay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case yay
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + pass + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case pass
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationDelegation.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDelegation.html new file mode 100644 index 00000000..b72471c6 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDelegation.html @@ -0,0 +1,968 @@ + + + + OperationDelegation Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationDelegation

+
+
+ +
public class OperationDelegation : Operation
+ +
+
+

Operation subclass for delegating an account to a baker

+ +
+
+
+
    +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    The baker to delegate too, or nil to undelegate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegate: String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationDelegation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(source: String, delegate: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + source + + +
    +

    The address of the acocunt sending the operation.

    +
    +
    + + delegate + + +
    +

    Optional. The address of the baker to delegate to, or nil to undelegate the source address.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationDelegation) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleBakingEvidence.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleBakingEvidence.html new file mode 100644 index 00000000..ad4b518f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleBakingEvidence.html @@ -0,0 +1,900 @@ + + + + OperationDoubleBakingEvidence Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationDoubleBakingEvidence

+
+
+ +
public class OperationDoubleBakingEvidence : Operation
+ +
+
+

Operation to report a baking of baking the same block twice

+ +
+
+
+
    +
  • +
    + + + + bh1 + +
    +
    +
    +
    +
    +
    +

    The block header of the first baked block

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bh1: OperationBlockHeader
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bh2 + +
    +
    +
    +
    +
    +
    +

    The block header of the second baked block

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bh2: OperationBlockHeader
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(wallet:bh1:bh2:) + +
    +
    +
    +
    +
    +
    +

    Init with wallet and two block headers

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, bh1: OperationBlockHeader, bh2: OperationBlockHeader)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationDoubleBakingEvidence) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleEndorsementEvidence.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleEndorsementEvidence.html new file mode 100644 index 00000000..2751ba95 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleEndorsementEvidence.html @@ -0,0 +1,928 @@ + + + + OperationDoubleEndorsementEvidence Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationDoubleEndorsementEvidence

+
+
+ +
public class OperationDoubleEndorsementEvidence : Operation
+ +
+
+

Operation to report a baker trying to endorse a block twice

+ +
+
+
+
    +
  • +
    + + + + InlinedEndorsement + +
    +
    +
    +
    +
    +
    +

    Internal struct used to amtch expected struct of data

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct InlinedEndorsement : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + op1 + +
    +
    +
    +
    +
    +
    +

    The first endorsement

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let op1: InlinedEndorsement
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + op2 + +
    +
    +
    +
    +
    +
    +

    The second endorsement (should be matching details of first)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let op2: InlinedEndorsement
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(wallet:op1:op2:) + +
    +
    +
    +
    +
    +
    +

    Init with wallet and 2 suspected endorsements

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, op1: InlinedEndorsement, op2: InlinedEndorsement)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationDoubleEndorsementEvidence) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html new file mode 100644 index 00000000..78c3b380 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html @@ -0,0 +1,846 @@ + + + + InlinedEndorsement Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

InlinedEndorsement

+
+
+ +
public struct InlinedEndorsement : Codable, Equatable
+ +
+
+

Internal struct used to amtch expected struct of data

+ +
+
+
+
    +
  • +
    + + + + branch + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let branch: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operations + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operations: Content
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + signature + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let signature: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Content + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Content : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html new file mode 100644 index 00000000..d9a7f2ca --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html @@ -0,0 +1,792 @@ + + + + Content Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Content

+
+
+ +
public struct Content : Codable, Equatable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + kind + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let kind: OperationKind
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationEndorsement.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationEndorsement.html new file mode 100644 index 00000000..9e912315 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationEndorsement.html @@ -0,0 +1,873 @@ + + + + OperationEndorsement Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationEndorsement

+
+
+ +
public class OperationEndorsement : Operation
+ +
+
+

Operation for endorsing a block

+ +
+
+
+
    +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    +

    Block level

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(wallet:level:) + +
    +
    +
    +
    +
    +
    +

    Init with wallet and block level

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, level: Int)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationEndorsement) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationFactory.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationFactory.html new file mode 100644 index 00000000..bc1e64f6 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationFactory.html @@ -0,0 +1,2017 @@ + + + + OperationFactory Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationFactory

+
+
+ +
public class OperationFactory
+ +
+
+

Class responsible for creating operations necessary to perform a given action, and converting those operations into the single payload expected by the RPC. +Although not every action requires more than one operation, all functions will return an array, for consistency.

+ +
+
+
+
+ + +
+ +

Operation Builders +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to send an amount of a token to a destination address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sendOperation(_ tokenAmount: TokenAmount, of token: Token, from: String, to: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + _ + + +
    +

    The amount of the given token to send.

    +
    +
    + + of + + +
    +

    The Token type that will be sent.

    +
    +
    + + from + + +
    +

    The address to deduct the funds from.

    +
    +
    + + to + + +
    +

    The destination address that will recieve the funds.

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to send aan NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sendOperation(_ amount: Decimal, ofNft nft: NFT, from: String, to: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + ofNft + + +
    +

    The NFT type that will be sent.

    +
    +
    + + from + + +
    +

    The address to deduct the funds from.

    +
    +
    + + to + + +
    +

    The destination address that will recieve the funds.

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to delegate funds to a baker.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func delegateOperation(to: String, from: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + to + + +
    +

    The address of the baker to delegate to.

    +
    +
    + + from + + +
    +

    The address that wishes to delegate its funds.

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to remove the current delegate from an address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func undelegateOperation(address: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + address + + +
    +

    The address that wishes to remove its delegate.

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to perform an exchange of XTZ for a given FA token, using a given dex

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func swapXtzToToken(withDex dex: DipDupExchange, xtzAmount: XTZAmount, minTokenAmount: TokenAmount, walletAddress: String, timeout: TimeInterval) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + withDex + + +
    +

    Enum controling which dex to use to perform the swap

    +
    +
    + + xtzAmount + + +
    +

    The amount of XTZ to be swaped

    +
    +
    + + minTokenAmount + + +
    +

    The minimum token amount you will accept

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    + + timeout + + +
    +

    Max amount of time to wait before asking the node to cancel the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to perform an exchange of a given FA token for XTZ, using dex contracts

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func swapTokenToXTZ(withDex dex: DipDupExchange, tokenAmount: TokenAmount, minXTZAmount: XTZAmount, walletAddress: String, timeout: TimeInterval) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + withDex + + +
    +

    DipDupExchange instance providing information about the exchange

    +
    +
    + + tokenAmount + + +
    +

    The amount of Token to be swapped

    +
    +
    + + minXTZAmount + + +
    +

    The minimum xtz amount you will accept

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    + + timeout + + +
    +

    Max amount of time to wait before asking the node to cancel the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Allowance (approve, update_operators) +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create an operation to call the entrypoint approve, to allow another address to spend some of your token (only FA1.2) +Used when interacting with smart contract applications like Dexter or QuipuSwap

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func approveOperation(tokenAddress: String, spenderAddress: String, allowance: TokenAmount, walletAddress: String) -> Operation
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + tokenAddress + + +
    +

    The address of the token contract

    +
    +
    + + spenderAddress + + +
    +

    The address that is being given permission to spend the users balance

    +
    +
    + + allowance + + +
    +

    The allowance to set for the given contract

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An OperationTransaction which will invoke a smart contract call

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an operation to call the entrypoint update_operators, to allow another address to spend some of your token (only FA2) +Used when interacting with smart contract applications like Dexter or QuipuSwap

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func updateOperatorsOperation(tokenAddress: String, spenderAddress: String, allowance: TokenAmount, walletAddress: String) -> Operation
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + tokenAddress + + +
    +

    The address of the token contract

    +
    +
    + + spenderAddress + + +
    +

    The address that is being given permission to spend the users balance

    +
    +
    + + allowance + + +
    +

    The allowance to set for the given contract

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An OperationTransaction which will invoke a smart contract call

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return the operation necessary to register an allowance (either calling apporve or update_operators) depending on the token standard version. Removing the need to check manually +Used when interacting with smart contract applications like Dexter or QuipuSwap

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func allowanceOperation(standard: DipDupTokenStandard, tokenAddress: String, spenderAddress: String, allowance: TokenAmount, walletAddress: String) -> Operation
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + standard + + +
    +

    The FA standard that the token conforms too

    +
    +
    + + tokenAddress + + +
    +

    The address of the token contract

    +
    +
    + + spenderAddress + + +
    +

    The address that is being given permission to spend the users balance

    +
    +
    + + allowance + + +
    +

    The allowance to set for the given contract

    +
    +
    + + wallet + + +
    +

    The wallet signing the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An OperationTransaction which will invoke a smart contract call

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Dex functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to add liquidity to a dex contract. Use DexCalculationService to figure out the numbers required

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func addLiquidity(withDex dex: DipDupExchange, xtz: XTZAmount, token: TokenAmount, minLiquidty: TokenAmount, isInitialLiquidity: Bool, walletAddress: String, timeout: TimeInterval) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + withDex + + +
    +

    DipDupExchange instance providing information about the exchange

    +
    +
    + + xtz + + +
    +

    The amount of XTZ to deposit

    +
    +
    + + token + + +
    +

    The amount of Token to deposit

    +
    +
    + + minLiquidty + + +
    +

    The minimum amount of liquidity tokens you will accept

    +
    +
    + + isInitialLiquidity + + +
    +

    Is this the xtzPool and tokenPool empty? If so, the operation needs to set the exchange rate for the dex. Some dex’s require extra logic here

    +
    +
    + + wallet + + +
    +

    The wallet that will sign the operation

    +
    +
    + + timeout + + +
    +

    The timeout in seconds, before the dex contract should cancel the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to remove liquidity from a dex contract, also withdraw pending rewards if applicable. Use DexCalculationService to figure out the numbers required

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func removeLiquidity(withDex dex: DipDupExchange, minXTZ: XTZAmount, minToken: TokenAmount, liquidityToBurn: TokenAmount, walletAddress: String, timeout: TimeInterval) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + withDex + + +
    +

    DipDupExchange instance providing information about the exchange

    +
    +
    + + minXTZ + + +
    +

    The minimum XTZ to accept in return for the burned amount of Liquidity

    +
    +
    + + minToken + + +
    +

    The minimum Token to accept in return for the burned amount of Liquidity

    +
    +
    + + liquidityToBurn + + +
    +

    The amount of Liqudity to burn

    +
    +
    + + wallet + + +
    +

    The wallet that will sign the operation

    +
    +
    + + timeout + + +
    +

    The timeout in seconds, before the dex contract should cancel the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create the operations necessary to withdraw rewards from a dex contract. For example in quipuswap, XTZ provided as liquidity will earn baking rewards. This can been withdrawn at any time while leaving liquidity in palce

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func withdrawRewards(withDex dex: DipDupExchange, walletAddress: String) -> [Operation]
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + withDex + + +
    +

    DipDupExchange instance providing information about the exchange

    +
    +
    + + wallet + + +
    +

    The wallet that will sign the operation

    +
    +
    +
    +
    +

    Return Value

    +

    An array of Operation subclasses.

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Utilities +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Convert an array of operations into the format expected by the RPC. Will also inject a OperationReveal if the sender has not yet revealed their public key.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func operationPayload(fromMetadata metadata: OperationMetadata, andOperations operations: [Operation], walletAddress: String, base58EncodedPublicKey: String) -> OperationPayload
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + fromMetadata + + +
    +

    OperationMeatdata containing necessary data to form the object.

    +
    +
    + + andOperations + + +
    +

    An array of Operation subclasses to send.

    +
    +
    + + withWallet + + +
    +

    The Wallet instance that will be responsible for these operations.

    +
    +
    +
    +
    +

    Return Value

    +

    An instance of OperationPayload that can be sent to the RPC

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Dexter requires date strings to act as deadline dates for exchanges. +This function takes a TimeInterval and uses it to createa date in the future, and returns that as a formatted string.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func createDexterTimestampString(nowPlusTimeInterval: TimeInterval) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + nowPlusTimeInterval + + +
    +

    The amount of time in the future the date string should represent.

    +
    +
    +
    +
    +

    Return Value

    +

    A formatted date String

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func sendTokenMichelson(forFaVersion faVersion: FaVersion, tokenAmount: TokenAmount, tokenId: Decimal, to: String, from: String) -> [String : Any]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Extractors +

+
+
+
    +
  • +
    + + + + Extractor + +
    +
    +
    +
    +
    +
    +

    Internal Struct to encapsulate helpers methods needed to extract critical information from an array of operations, needed for processing decisions like “do i display a send token screen, or a send NFt screen”, fetching total XTZ sent in 1 action etc

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Extractor
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationFactory/Extractor.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationFactory/Extractor.html new file mode 100644 index 00000000..a5b5f6b2 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationFactory/Extractor.html @@ -0,0 +1,961 @@ + + + + Extractor Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Extractor

+
+
+ +
public struct Extractor
+ +
+
+

Internal Struct to encapsulate helpers methods needed to extract critical information from an array of operations, needed for processing decisions like “do i display a send token screen, or a send NFt screen”, fetching total XTZ sent in 1 action etc

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Extract rpc amount (without decimal info) a tokenId, and the destination from a michelson FA1.2 / FA2 transfer payload

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func tokenIdAndAmountFromSendMichelson(michelson: Any) -> (rpcAmount: String, tokenId: Decimal?, destination: String)?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Extract details from a payload in order to present to the user what it is they are trying to send

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func faTokenDetailsFrom(transaction: OperationTransaction) -> (tokenContract: String, rpcAmount: String, tokenId: Decimal?, destination: String)?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper to call faTokenDetailsFrom(transaction: OperationTransaction) on the first OperationTransaction in an array of operations. Allows to more easily parse an array of operations that may include approval‘s or update_operator calls

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func faTokenDetailsFrom(operations: [Operation]) -> (tokenContract: String, rpcAmount: String, tokenId: Decimal?, destination: String)?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return true if

    + +
      +
    • contains 1 operation with a non-zero amount, with no parameters
    • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func isTezTransfer(operations: [Operation]) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Easy way to extract the first non-approval or update_operator transaction

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func firstTransferEntrypointOperation(operations: [Operation]) -> OperationTransaction?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return the entrypoint and address of the first operation, that doesn’t equal approve, update_operator or transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func isContractCall(operations: [Operation]) -> (entrypoint: String, address: String)?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return the first operation where entrypoint doesn’t equal approve, update_operator or transfer

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func firstContractCallOperation(operations: [Operation]) -> OperationTransaction?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Run through list of operations and extract .amount from any OperationTransaction

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func totalXTZAmountForContractCall(operations: [Operation]) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationOrigination.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationOrigination.html new file mode 100644 index 00000000..0313083a --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationOrigination.html @@ -0,0 +1,1019 @@ + + + + OperationOrigination Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationOrigination

+
+
+ +
public class OperationOrigination : Operation
+ +
+
+

Operation subclass for originating a contract on the Tezos network

+ +
+
+
+
    +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    The initial balance to give to the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + script + +
    +
    +
    +
    +
    +
    +

    Dictionary holding the code and storage of the contract to create.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let script: [String : String]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationOrigination.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(source: String, balance: XTZAmount, code: String, storage: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + source + + +
    +

    The address originating the contract and paying the fees.

    +
    +
    + + balance + + +
    +

    How much XTZ to initiate the contract with.

    +
    +
    + + code + + +
    +

    Micheline string containing the contract code.

    +
    +
    + + storage + + +
    +

    Micheline string containing the initial storage of the contract.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationOrigination) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationProposals.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationProposals.html new file mode 100644 index 00000000..1d5b03ea --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationProposals.html @@ -0,0 +1,899 @@ + + + + OperationProposals Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationProposals

+
+
+ +
public class OperationProposals : Operation
+ +
+
+ +
+
+
+
    +
  • +
    + + + + period + +
    +
    +
    +
    +
    +
    +

    The voting period

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let period: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proposals + +
    +
    +
    +
    +
    +
    +

    List of proposal identifiers

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let proposals: [String]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init with wallet, voting period and list of proposal identifiers

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, period: Int, proposals: [String])
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationProposals) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationReveal.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationReveal.html new file mode 100644 index 00000000..c2c046c0 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationReveal.html @@ -0,0 +1,1013 @@ + + + + OperationReveal Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationReveal

+
+
+ +
public class OperationReveal : Operation
+ +
+
+

Operation subclass for revealing a publickey to the network.

+ +
+
+
+
    +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let publicKey: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(wallet:) + +
    +
    +
    +
    +
    +
    +

    Create an OperationReveal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + wallet + + +
    +

    The Wallet object, whose publicKey needs to be revealed.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationReveal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(base58EncodedPublicKey: String, walletAddress: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + base58EncodedPublicKey + + +
    +

    The Wallet object, whose publicKey needs to be revealed.

    +
    +
    + + walletAddress + + +
    +

    The Wallet object, whose publicKey needs to be revealed.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationReveal) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationSeedNonceRevelation.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationSeedNonceRevelation.html new file mode 100644 index 00000000..e1f54071 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationSeedNonceRevelation.html @@ -0,0 +1,899 @@ + + + + OperationSeedNonceRevelation Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationSeedNonceRevelation

+
+
+ +
public class OperationSeedNonceRevelation : Operation
+ +
+
+

Operation to reveal seed nonce to blockchain

+ +
+
+
+
    +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    +

    Block level

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nonce + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let nonce: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init with wallet object, block level, and nonce

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wallet: Wallet, level: Int, nonce: String)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationSeedNonceRevelation) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationService.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationService.html new file mode 100644 index 00000000..db2c5e82 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationService.html @@ -0,0 +1,1530 @@ + + + + OperationService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationService

+
+
+ +
public class OperationService
+ +
+
+

Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

+ +
+
+
+
    +
  • +
    + + + + OperationServiceError + +
    +
    +
    +
    +
    +
    +

    Errors that the OperationService is capable of returning

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum OperationServiceError : Error
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Used to return a bunch of formatted data, to make interacting with ledger sign operation easier

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct LedgerPayloadPrepResponse
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + config + +
    +
    +
    +
    +
    +
    +

    The configuration object containing all the necessary settings to connect and communicate with the Tezos node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let config: TezosNodeClientConfig
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkService + +
    +
    +
    +
    +
    +
    +

    The NetworkService object that will perform all the networking calls

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let networkService: NetworkService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Top level functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    When using remote forging, every Operation needs to be Forged, Parsed, Signed, Preapply’d and Injected to make its way into the blockchain. +This function will complete all of those steps and return an OperationID or an Error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func remoteForgeParseSignPreapplyInject(operationMetadata: OperationMetadata, operationPayload: OperationPayload, wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + operationMetadata + + +
    +

    The latest OperationMetadata from the TezosNodeClient

    +
    +
    + + operationPayload + + +
    +

    The OperationPayload generated by the OperationFactory

    +
    +
    + + wallet + + +
    +

    The Wallet that will sign the operation

    +
    +
    + + completion + + +
    +

    Completion block either returning a String containing an OperationHash of the injected Operation, or an Error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    When using local forging, every Operation needs to be Forged, Signed, Preapply’d and Injected to make its way into the blockchain. +This function will complete all of those steps and return an OperationID or an Error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func localForgeSignPreapplyInject(operationMetadata: OperationMetadata, operationPayload: OperationPayload, wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + operationMetadata + + +
    +

    The latest OperationMetadata from the TezosNodeClient

    +
    +
    + + operationPayload + + +
    +

    The OperationPayload generated by the OperationFactory

    +
    +
    + + wallet + + +
    +

    The Wallet that will sign the operation

    +
    +
    + + completion + + +
    +

    Completion block either returning a String containing an OperationHash of the injected Operation, or an Error

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Helpers / wrappers +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Ledger can only parse operations under certain conditions. These conditions are not documented well. This function will attempt to determine whether the payload can be parsed or not, and returnt he appropriate string for the LedgerWallet sign function +It seems to be able to parse the payload if it contains 1 operation, of the below types. Combining types (like Reveal + Transation) causes a parse error +If the payload structure passes the conditions we are aware of, allow parsing to take place. If not, sign blake2b hash instead

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func ledgerStringToSign(forgedHash: String, operationPayload: OperationPayload) -> String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Preapply and Inject wrapped up as one function, for situations like Ledger Wallets, where signing is a complately different process, and must be done elsewhere

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func preapplyAndInject(forgedOperation: String, signature: [UInt8], signatureCurve: EllipticalCurve, operationPayload: OperationPayload, operationMetadata: OperationMetadata, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + forgedOperation + + +
    +

    The forged operation hex without a watermark.

    +
    +
    + + signature + + +
    +

    Binary representation of the signed operation forge.

    +
    +
    + + signatureCurve + + +
    +

    The curve used to sign the forge.

    +
    +
    + + operationPayload + + +
    +

    The payload to be sent.

    +
    +
    + + operationMetadata + + +
    +

    The metadata required to send the payload.

    +
    +
    + + completion + + +
    +

    callback with a forged hash or an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Forge an OperationPayload remotely, so it can be sent to the RPC.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func remoteForge(operationPayload: OperationPayload, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + operationPayload + + +
    +

    created from OperationFactory.operationPayload().

    +
    +
    + + wallet + + +
    +

    The Wallet object that will sign the operations.

    +
    +
    + + completion + + +
    +

    callback with a forged hash or an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Parse a forged OperationPayload on a different server to ensure nobody maliciously tampared with the request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func remoteParse(forgeResult: Result<String, KukaiError>, operationMetadata: OperationMetadata, operationPayload: OperationPayload, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + forgeResult + + +
    +

    The Result object from the forge(...) function.

    +
    +
    + + operationMetadata + + +
    +

    fetched from getOperationMetadata(...).

    +
    +
    + + operationPayload + + +
    +

    the OperationPayload to compare against to ensure it matches.

    +
    +
    + + completion + + +
    +

    callback which just returns success or failure with an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Preapply a signed OperationPayload to check for any errors.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func preapply(operationPayload: OperationPayload, completion: @escaping ((Result<[OperationResponse], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + operationMetadata + + +
    +

    Fetched from getOperationMetadata(...).

    +
    +
    + + operationPayload + + +
    +

    An OperationPayloadthat has had a signature and a protcol added to it.

    +
    +
    + + completion + + +
    +

    Callback which just returns success or failure with an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Inject a signed bytes to become part of the next block on the blockchain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func inject(signedBytes: String, handlePreapplyResult: Result<[OperationResponse], KukaiError>?, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + signedBytes + + +
    +

    The result of the forge operation (as a string) with the signature (as a hex string) appended on.

    +
    +
    + + handlePreapplyResult + + +
    +

    Optionally pass in the result of the preapply function to reduce the indentation required to perform the full set of operations. Any error will be returned via the injection Result object.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationService/LedgerPayloadPrepResponse.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationService/LedgerPayloadPrepResponse.html new file mode 100644 index 00000000..ffc09580 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationService/LedgerPayloadPrepResponse.html @@ -0,0 +1,897 @@ + + + + LedgerPayloadPrepResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LedgerPayloadPrepResponse

+
+
+ +
public struct LedgerPayloadPrepResponse
+ +
+
+

Used to return a bunch of formatted data, to make interacting with ledger sign operation easier

+ +
+
+
+
    +
  • +
    + + + + payload + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payload: OperationPayload
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + forgedOp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let forgedOp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + watermarkedOp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let watermarkedOp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + blake2bHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let blake2bHash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let metadata: OperationMetadata
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + canLedgerParse + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let canLedgerParse: Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationService/OperationServiceError.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationService/OperationServiceError.html new file mode 100644 index 00000000..ba97aec0 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationService/OperationServiceError.html @@ -0,0 +1,949 @@ + + + + OperationServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationServiceError

+
+
+ +
public enum OperationServiceError : Error
+ +
+
+

Errors that the OperationService is capable of returning

+ +
+
+
+
    +
  • +
    + + + + unableToSetupForge + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToSetupForge
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unableToSetupParse + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToSetupParse
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseFailed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parseFailed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + signingFailure + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case signingFailure
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unableToSetupPreapply + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToSetupPreapply
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case preapplyContainedError(errors: [OperationResponseInternalResultError]?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unableToSetupInject + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToSetupInject
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + noRemoteParseURLFound + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noRemoteParseURLFound
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/OperationTransaction.html b/docsets/.docset/Contents/Resources/Documents/Classes/OperationTransaction.html new file mode 100644 index 00000000..fd0c6f58 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/OperationTransaction.html @@ -0,0 +1,1110 @@ + + + + OperationTransaction Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationTransaction

+
+
+ +
public class OperationTransaction : Operation
+ +
+
+

Operation subclass for sending XTZ to a destination

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var amount: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + destination + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let destination: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parameters + +
    +
    +
    +
    +
    +
    +

    Dictionary holding the entrypoint and value of the contract call

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parameters: [String : Any]?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Constructors +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create an OperationTransaction, to send an amount of token to a destination

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(amount: TokenAmount, source: String, destination: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value.

    +
    +
    + + source + + +
    +

    The address of the acocunt sending the operation.

    +
    +
    + + destination + + +
    +

    The destination address to recieve the funds.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationTransaction, to invoke a smart contract call

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(amount: TokenAmount, source: String, destination: String, parameters: [String : Any])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value.

    +
    +
    + + source + + +
    +

    The address of the acocunt sending the operation.

    +
    +
    + + parameters + + +
    +

    A dictionary containing the michlelson JSON representation needed to invoke a smart contract. Should contain a key entrypoint with a string and value which can either be a dictionary of anything, or an array of dicitonaries of anything

    +
    +
    + + destination + + +
    +

    The destination address to recieve the funds.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable +

+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public required init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    +

    A function to check if two operations are equal.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isEqual(_ op: OperationTransaction) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + _ + + +
    +

    An Operation to compare against

    +
    +
    +
    +
    +

    Return Value

    +

    A Bool indicating the result.

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/RPC.html b/docsets/.docset/Contents/Resources/Documents/Classes/RPC.html new file mode 100644 index 00000000..48d112ca --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/RPC.html @@ -0,0 +1,1478 @@ + + + + RPC Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

RPC

+
+
+ +
public class RPC<T> where T : Decodable
+ +
+
+

A generic class representing an RPC call to the Tezos network. +A type must be passed in when creating an instance of this object, this will be used by the network layer to parse the response and detect errors.

+ +
+
+
+
+ + +
+ +

Public properties +

+
+
+
    +
  • +
    + + + + endpoint + +
    +
    +
    +
    +
    +
    +

    The endpoint that will be added onto the TezosNodeConfig.primaryNodeURL to form a full URL for the request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let endpoint: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payload + +
    +
    +
    +
    +
    +
    +

    An optional payload for sending HTTP POST requests

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payload: Data?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + responseType + +
    +
    +
    +
    +
    +
    +

    The expected response type from the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let responseType: T.Type
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isPost + +
    +
    +
    +
    +
    +
    +

    Computed property to indicate wheter or not this is a POST request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isPost: Bool { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Init an RPC object, to be passed to the network layer to performa request to the node.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(endpoint: String, payload: Data?, responseType: T.Type)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + endpoint + + +
    +

    The endpoint to send the request too.

    +
    +
    + + payload + + +
    +

    An optional payload for POST requests.

    +
    +
    + + responseType + + +
    +

    The expected response type from the network.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper function to wrap up JSONEncoder().encode and log any errors.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func encodableToData<T>(encodable: T) -> Data? where T : Encodable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == String +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch an XTZ balance for a given Address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func xtzBalance(forAddress address: String) -> RPC<String>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch a deelgate for a given Address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func getDelegate(forAddress address: String) -> RPC<String>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the managerKey for a given Address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func managerKey(forAddress address: String) -> RPC<String?>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter(forAddress:) + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the current counter for a given Address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func counter(forAddress address: String) -> RPC<String>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to remotely forge an operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func forge(operationPayload: OperationPayload) -> RPC<String>?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + inject(signedBytes:) + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to inject an operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func inject(signedBytes: String) -> RPC<String>?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == BlockchainHead +

+
+
+
    +
  • +
    + + + + blockchainHead() + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the HEAD of the blockchain and parse it into an object to extract the pieces we are interested in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func blockchainHead() -> RPC<BlockchainHead>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the HEAD of 3 blocks previous and parse it into an object to extract the pieces we are interested in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func blockchainHeadMinus3() -> RPC<BlockchainHead>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == NetworkVersion +

+
+
+
    +
  • +
    + + + + networkVersion() + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the details about the version of the network running on the given server.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func networkVersion() -> RPC<NetworkVersion>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == NetworkConstants +

+
+
+
    +
  • +
    + + + + networkConstants() + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the network constants for the given server, such as how much mutez it costs per byte of storage, or the maximum allowed gas amount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func networkConstants() -> RPC<NetworkConstants>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == [OperationPayload] +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to remotely parse an operation to verify its contents. Function takes in a hash, as it is returned from the forge call. This function will do all the necessary parsing and formatting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func parse(hashToParse: String, metadata: OperationMetadata) -> RPC<[OperationPayload]>?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where T == [OperationResponse] +

+
+
+ +
+
+
+ + +
+ +

Available where T == OperationResponse +

+
+
+ +
+
+
+ + +
+ +

Available where T == Data +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates an RPC to fetch a contracts Michelson storage

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func contractStorage(contractAddress: String) -> RPC<Data>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bigMap(id:) + +
    +
    +
    +
    +
    +
    +

    Creates an RPC to fetch the contents of the given big map

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func bigMap(id: String) -> RPC<Data>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/RegularWallet.html b/docsets/.docset/Contents/Resources/Documents/Classes/RegularWallet.html new file mode 100644 index 00000000..29e3a4aa --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/RegularWallet.html @@ -0,0 +1,1215 @@ + + + + RegularWallet Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

RegularWallet

+
+
+ +
public class RegularWallet : Wallet
+
extension RegularWallet: Equatable
+
extension RegularWallet: Hashable
+ +
+
+

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

+ +

This wallet is a non-HD wallet, sometimes referred to as a “legacy” wallet. It follows the Bip39 standard for generation via menmonic.

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    enum used to differientate wallet class types. Needed for applications that allow users to create many different types of wallets

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: WalletType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The TZ1 or TZ2 address of the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKey + +
    +
    +
    +
    +
    +
    +

    An object representing the PrivateKey used to generate the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var privateKey: PrivateKey
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    +

    An object representing the PublicKey used to generate the wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var publicKey: PublicKey
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mnemonic + +
    +
    +
    +
    +
    +
    +

    Optional Bip39 mnemonic used to generate the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var mnemonic: Mnemonic?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Attempt to create an instance of a RegularWallet from an encoded string containing a private key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(secp256k1WithBase58String base58String: String, type: WalletType)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + secp256k1WithBase58String + + +
    +

    String containing the Base58 encoded private key, prefixed with the curve’s secret

    +
    +
    + + type + + +
    +

    WalletType indicating the top most type of wallet

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a RegularWallet by supplying a Mnemonic and a passphrase (or “” if none).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(withMnemonic mnemonic: Mnemonic, passphrase: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + withMnemonic + + +
    +

    A Mnemonic representing a BIP39 menmonic

    +
    +
    + + passphrase + + +
    +

    String contianing a passphrase, or empty string if none

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a RegularWallet by asking for a mnemonic of a given number of words and a passphrase (or “” if none).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(withMnemonicLength length: Mnemonic.NumberOfWords, passphrase: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + withMnemonicLength + + +
    +

    Mnemonic.NumberOfWords the number of words to use when creating a mnemonic

    +
    +
    + + passphrase + + +
    +

    String contianing a passphrase, or empty string if none

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Crypto Functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Sign a hex payload with the private key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKeyCurve() + +
    +
    +
    +
    +
    +
    +

    Return the curve used to create the key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func privateKeyCurve() -> EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a Base58 encoded version of the public key, in order to reveal the address on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func publicKeyBase58encoded() -> String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: RegularWallet, rhs: RegularWallet) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TaquitoService.html b/docsets/.docset/Contents/Resources/Documents/Classes/TaquitoService.html new file mode 100644 index 00000000..1f0a2d1f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TaquitoService.html @@ -0,0 +1,932 @@ + + + + TaquitoService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TaquitoService

+
+
+ +
public class TaquitoService
+ +
+
+

Taquito (https://github.com/ecadlabs/taquito) is a popular open source Tezos library written in Typescript and Javascript. +Taquito is made up of many separate packages that deal with various aspects of Tezos RPC and Michelson. +This serivce class is a wrapper around a small piece of the Taquito library to expose funtionality that would otherwise be time consuming/risky/dangerous to re-implement natively. +The JS can now be found on each github release here: https://github.com/ecadlabs/taquito/releases/, by extracting the zip named “taquito-local-forging-vanilla.zip”

+ +
+
+
+
    +
  • +
    + + + + TaquitoServiceError + +
    +
    +
    +
    +
    +
    +

    Unique TaquitoService errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TaquitoServiceError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Public shared instace to avoid having multiple copies of the underlying JSContext created

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let shared: TaquitoService
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

@taquito/local-forging +

+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TaquitoService/TaquitoServiceError.html b/docsets/.docset/Contents/Resources/Documents/Classes/TaquitoService/TaquitoServiceError.html new file mode 100644 index 00000000..c29aa21e --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TaquitoService/TaquitoServiceError.html @@ -0,0 +1,793 @@ + + + + TaquitoServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TaquitoServiceError

+
+
+ +
public enum TaquitoServiceError : Error
+ +
+
+

Unique TaquitoService errors

+ +
+
+
+
    +
  • +
    + + + + alreadyForging + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case alreadyForging
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + alreadyParsing + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case alreadyParsing
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TezosDomainsClient.html b/docsets/.docset/Contents/Resources/Documents/Classes/TezosDomainsClient.html new file mode 100644 index 00000000..c88fc446 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TezosDomainsClient.html @@ -0,0 +1,1028 @@ + + + + TezosDomainsClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsClient

+
+
+ +
public class TezosDomainsClient
+ +
+
+

A client class allowing integration with the tezos domains GraphQL API. See more here: https://tezos.domains/

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Object to wrap up a response fomr both networks

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BothNetworkReverseRecord
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Public single functions +

+
+
+ +
+
+
+ + +
+ +

Public bulk functions +

+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TezosDomainsClient/BothNetworkReverseRecord.html b/docsets/.docset/Contents/Resources/Documents/Classes/TezosDomainsClient/BothNetworkReverseRecord.html new file mode 100644 index 00000000..bd940bdf --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TezosDomainsClient/BothNetworkReverseRecord.html @@ -0,0 +1,819 @@ + + + + BothNetworkReverseRecord Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BothNetworkReverseRecord

+
+
+ +
public struct BothNetworkReverseRecord
+ +
+
+

Object to wrap up a response fomr both networks

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TezosNodeClient.html b/docsets/.docset/Contents/Resources/Documents/Classes/TezosNodeClient.html new file mode 100644 index 00000000..17ca5f8d --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TezosNodeClient.html @@ -0,0 +1,1626 @@ + + + + TezosNodeClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosNodeClient

+
+
+ +
public class TezosNodeClient
+ +
+
+

The TezosNodeClient offers methods for interacting with the Tezos node to fetch balances, send transactions etc. +The client will abstract away all the compelx tasks of remote forging, parsing, signing, preapply and injecting operations. +It will also convert amounts from the network into Token objects to make common tasks easier.

+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + config + +
    +
    +
    +
    +
    +
    +

    The configuration object containing all the necessary settings to connect and communicate with the Tezos node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let config: TezosNodeClientConfig
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkService + +
    +
    +
    +
    +
    +
    +

    The NetworkService object that will perform all the networking calls

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var networkService: NetworkService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationService + +
    +
    +
    +
    +
    +
    +

    The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var operationService: OperationService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + feeEstimatorService + +
    +
    +
    +
    +
    +
    +

    The service responsible for calculating network fees on behalf of the user

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var feeEstimatorService: FeeEstimatorService
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkVersion + +
    +
    +
    +
    +
    +
    +

    Available information about the version of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var networkVersion: NetworkVersion?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkConstants + +
    +
    +
    +
    +
    +
    +

    Available information about the constants of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var networkConstants: NetworkConstants?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosNodeClientError + +
    +
    +
    +
    +
    +
    +

    Types of errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TezosNodeClientError : Error
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • +
    + + + + init(config:) + +
    +
    +
    +
    +
    +
    +

    Init a TezosNodeClient with a TezosNodeClientConfig.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(config: TezosNodeClientConfig = TezosNodeClientConfig(withDefaultsForNetworkType: .mainnet))
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + config + + +
    +

    A configuration object containing all the necessary settings to connect and communicate with the Tezos node.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Balance +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Gets the xtz balance for a given Address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBalance(forAddress address: String, completion: @escaping ((Result<XTZAmount, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    A Tezos network address, starting with "tz1", "tz2", "tz3" or "kt1"

    +
    +
    + + completion + + +
    +

    A callback containing a new Token object matching the xtz standard, or an error.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Delegate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Gets the delegate for the given address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getDelegate(forAddress address: String, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    A Tezos network address, starting with "tz1", "tz2", "tz3" or "kt1"

    +
    +
    + + completion + + +
    +

    A callback containing a String with the delegate/baker’s address, or an error.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Estimate +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Take an array of operations and estimate the gas, storage, baker fee and burn fees required to inject it onto the network +If the supplied operations contain suggested fees (e.g. from a dApp) this function will estimate the fee and pick which ever is higher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func estimate(operations: [Operation], walletAddress: String, base58EncodedPublicKey: String, completion: @escaping ((Result<FeeEstimatorService.EstimationResult, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + operations + + +
    +

    An array of Operation‘s to be injected.

    +
    +
    + + wallet + + +
    +

    The Wallet that will sign the operation

    +
    +
    + + completion + + +
    +

    A callback containing an updated array of Operation‘s with fees set correctly, or an error.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Send +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Send an array of Operation‘s to the blockchain. Use OperationFactory to help create this array for common use cases.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func send(operations: [Operation], withWallet wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + operations + + +
    +

    An array of Operation subclasses to be sent to the network.

    +
    +
    + + withWallet + + +
    +

    The Wallet instance that will sign the transactions.

    +
    +
    + + completion + + +
    +

    A completion closure that will either return the opertionID of an injected operation, or an error.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Send an already contrsutructed OperationPayload with the necessary OperationMetadata without having to fetch metadata again.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func send(operationPayload: OperationPayload, operationMetadata: OperationMetadata, withWallet wallet: Wallet, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + operationPayload + + +
    +

    An OperationPayload that has already been constructed (e.g. from the estimation call).

    +
    +
    + + operationMetadata + + +
    +

    An OperationMetaData object containing all the info about the network that the call needs for forge -> inject.

    +
    +
    + + withWallet + + +
    +

    The Wallet instance that will sign the transactions.

    +
    +
    + + completion + + +
    +

    A completion closure that will either return the opertionID of an injected operation, or an error.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Blockchain Operations +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get all the metadata necessary from the network to perform operations.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getOperationMetadata(forWalletAddress: String, completion: @escaping ((Result<OperationMetadata, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forWallet + + +
    +

    The Wallet object that will be sending the operations.

    +
    +
    + + completion + + +
    +

    A callback that will be executed when the network requests finish.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the Michelson storage of a given contract from the blockchain.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getContractStorage(contractAddress: String, completion: @escaping ((Result<[String : Any], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + contractAddress + + +
    +

    The address of the contract to query.

    +
    +
    + + completion + + +
    +

    A callback with a Result object, with either a [String: Any] or an Error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the Michelson big map contents, from a given id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBigMap(id: String, completion: @escaping ((Result<[String : Any], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + id + + +
    +

    The big map id.

    +
    +
    + + completion + + +
    +

    A callback with a Result object, with either a [String: Any] or an Error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Query the server for the NetworkVersion and NetworkConstants, and store the responses in the tezosNodeClient properties networkVersion and networkConstants, +so they can be referred too by the application without having to constantly query t he server.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getNetworkInformation(completion: @escaping ((Bool, KukaiError?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    A callback with a Bool indicating success and an optional Error

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TezosNodeClient/TezosNodeClientError.html b/docsets/.docset/Contents/Resources/Documents/Classes/TezosNodeClient/TezosNodeClientError.html new file mode 100644 index 00000000..3b973b37 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TezosNodeClient/TezosNodeClientError.html @@ -0,0 +1,793 @@ + + + + TezosNodeClientError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosNodeClientError

+
+
+ +
public enum TezosNodeClientError : Error
+ +
+
+

Types of errors

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noDexterExchangeAddressFound
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonParsing + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case michelsonParsing
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/Token.html b/docsets/.docset/Contents/Resources/Documents/Classes/Token.html new file mode 100644 index 00000000..3a90714a --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/Token.html @@ -0,0 +1,1631 @@ + + + + Token Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Token

+
+
+ +
public class Token : Codable, CustomStringConvertible
+
extension Token: Equatable
+
extension Token: Hashable
+
extension Token: Identifiable
+ +
+
+

A class to represent a Token on the Tezos network. This class will do all the heavy lifting of converting values from the RPC to more human readbale values. +This class will also handle arithmetic functions, allowing developers to add and subtract tokens (useful when caluclating fees and total values).

+ +
+
+
+
    +
  • +
    + + + + TokenType + +
    +
    +
    +
    +
    +
    +

    An Enum to express the type of a token. Different processes are needed to fetch a balance for a users XTZ wallet, +versus fetching a FA1.2 token balance. This allows the library to abstract this logic away from the user and handle it all behind the scenes.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TokenType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The long name of a token. e.g. “Tezos”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    +

    The short name or the symbol of a token. e.g. “XTZ”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenType + +
    +
    +
    +
    +
    +
    +

    The type of this token. e.g. xtz, fungible, nonfungible

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenType: TokenType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + faVersion + +
    +
    +
    +
    +
    +
    +

    The FaVersion of the token contract, nil for XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let faVersion: FaVersion?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    Object that holds and formats the balance of the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var balance: TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimalPlaces + +
    +
    +
    +
    +
    +
    +

    Get the underlying number of decimal places that this token represents

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimalPlaces: Int { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + thumbnailURL + +
    +
    +
    +
    +
    +
    +

    The URL to a cached version of the asset (data that we add later on through other service calls)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var thumbnailURL: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + localCurrencyRate + +
    +
    +
    +
    +
    +
    +

    The current local currency rate of this token. Used to show the user the net worth of their holdings.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var localCurrencyRate: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenContractAddress + +
    +
    +
    +
    +
    +
    +

    In the case of FA1.2 or higher, we need to know the KT1 address for the token so we can fetch balances and make trades. (should be empty for xtz).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenContractAddress: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    +

    Each token type on a contract will have a unique token_id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tokenId: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isHidden + +
    +
    +
    +
    +
    +
    +

    Recording if the user has marked the token as hidden

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isHidden: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + favouriteSortIndex + +
    +
    +
    +
    +
    +
    +

    Recording if the position the index the user chose for the favourite token to appear

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var favouriteSortIndex: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nfts + +
    +
    +
    +
    +
    +
    +

    The individual NFT’s owned of this token type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var nfts: [NFT]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mintingTool + +
    +
    +
    +
    +
    +
    +

    The URL of the tool used to mint the item

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var mintingTool: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFavourite + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isFavourite: Bool { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Init a Token object that will hold all the necessary data to interact with the Tezos network, and the Dexter exchange

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(name: String?, symbol: String, tokenType: TokenType, faVersion: FaVersion?, balance: TokenAmount, thumbnailURL: URL?, tokenContractAddress: String?, tokenId: Decimal?, nfts: [NFT]?, mintingTool: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + name + + +
    +

    The long name of the token. e.g. “Tezos”

    +
    +
    + + symbol + + +
    +

    The short name of the token, or the symbol. e.g. “XTZ”

    +
    +
    + + tokenType + + +
    +

    The type of the token. e.g. xtz, fa1.2, fa2 etc.

    +
    +
    + + faVersion + + +
    +

    The FA standard / version used to create this token.

    +
    +
    + + decimalPlaces + + +
    +

    The number of decimal places this token contains.

    +
    +
    + + thumbnailURI + + +
    +

    URI to network asset to use to display an icon for the token

    +
    +
    + + tokenContractAddress + + +
    +

    The KT1 address of the contract (nil if xtz).

    +
    +
    + + tokenId + + +
    +

    The token id if the token is an FA2 token, nil otherwise.

    +
    +
    + + nfts + + +
    +

    The individual NFT’s owned of this token type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init a Token from an object returned by the TzKT API

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from: TzKTBalanceToken, andTokenAmount: TokenAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Init a Token from an object returned by the TzKT API

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from: TzKTTokenTransfer)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtz() + +
    +
    +
    +
    +
    +
    +

    Create a Token object with all the settings needed for XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func xtz() -> Token
    + +
    +
    +
    +

    Return Value

    +

    Token

    +
    +
    +
    +
  • +
  • +
    + + + + xtz(withAmount:) + +
    +
    +
    +
    +
    +
    +

    Create a Token object with all the settings needed for XTZ, with an initial amount. Useful for setting fees.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func xtz(withAmount amount: TokenAmount) -> Token
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + withAmount + + +
    +

    The Amount of XTZ to create the Token with.

    +
    +
    +
    +
    +

    Return Value

    +

    Token.

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Useful for creating placeholders for pending activity items

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func placeholder(fromNFT nft: NFT, amount: TokenAmount, thumbnailURL: URL?) -> Token
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isXTZ() + +
    +
    +
    +
    +
    +
    +

    Helper function to check if the Token instance being passed aroun is pointing to XTZ. As many functions will require different functionality for fa token versus XTZ

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isXTZ() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: Token, rhs: Token) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    +

    Conforming to Identifiable to enable working with ForEach and similiar looping functions + if faVersion present, use that to follow the standard of either tokenAddress or combination of tokenAddress + token id, fallback to using symbol if type is unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var id: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/Token/TokenType.html b/docsets/.docset/Contents/Resources/Documents/Classes/Token/TokenType.html new file mode 100644 index 00000000..88659098 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/Token/TokenType.html @@ -0,0 +1,820 @@ + + + + TokenType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TokenType

+
+
+ +
public enum TokenType : String, Codable
+ +
+
+

An Enum to express the type of a token. Different processes are needed to fetch a balance for a users XTZ wallet, +versus fetching a FA1.2 token balance. This allows the library to abstract this logic away from the user and handle it all behind the scenes.

+ +
+
+
+
    +
  • +
    + + + + xtz + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case xtz
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fungible + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fungible
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nonfungible + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case nonfungible
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TokenAmount.html b/docsets/.docset/Contents/Resources/Documents/Classes/TokenAmount.html new file mode 100644 index 00000000..ffcb1540 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TokenAmount.html @@ -0,0 +1,1612 @@ + + + + TokenAmount Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TokenAmount

+
+
+ +
public class TokenAmount : Codable
+
extension TokenAmount: Comparable
+
extension TokenAmount: Equatable
+
extension TokenAmount: CustomStringConvertible
+
extension TokenAmount: Hashable
+ +
+
+

Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length. +This class is used to encapsulate a BigInt and provide all the necessary init’s and formatting functions to work with the networks requirements.

+ +
+
+
+
    +
  • +
    + + + + TokenAmountError + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TokenAmountError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimalPlaces + +
    +
    +
    +
    +
    +
    +

    The number of decimal places that this token supports.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimalPlaces: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + rpcRepresentation + +
    +
    +
    +
    +
    +
    +

    Format the internal value to ensure it matches the format the RPC will expect

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var rpcRepresentation: String { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Basic formatting of a token to be human readable. For more advanced options, use the format function

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var normalisedRepresentation: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(fromRpcAmount rpcAmount: String, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromRpcAmount + + +
    +

    A string conforming to the RPC standard for the given token.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a decimal version of an RPC amount. e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(fromRpcAmount rpcAmount: Decimal, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromRpcAmount + + +
    +

    A decimal conforming to the RPC standard for the given token. Decimal places will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(fromNormalisedAmount normalisedAmount: Decimal, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNormalisedAmount + + +
    +

    A decimal containing an amount for the given token. Anything over the given decimal places for the token will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(fromNormalisedAmount normalisedAmount: String, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNormalisedAmount + + +
    +

    A string containing an amount for the given token. Anything over the given decimal places for the token will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + zero() + +
    +
    +
    +
    +
    +
    +

    Quickly create a TokenAmount with zero balance and no decimal places. +Warning: the decimal places attribute could be used by other code to determine precision. This should only be used in places where it is needed as a temporary, default value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class func zero() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Quickly create a TokenAmount with zero balance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public class func zeroBalance(decimalPlaces: Int) -> TokenAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable +

+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info. +This coder attempts to handle both states, first checking if its possible to extract both, if not, defaulting the decimal palces to zero, expecting the calling application to provide this information later on from another proptery or even another API call (such as a metadata query)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    required public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Display +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Format the current value into a human readable string, using the given locale.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func formatNormalisedRepresentation(locale: Locale) -> String?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + locale + + +
    +

    The locale to use to decide whether to use decimal or comma, comma or spaces etc, when formattting the number

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + toRpcDecimal() + +
    +
    +
    +
    +
    +
    +

    Function to convert the underlying rpc value into a Decimal which can be useful in some situations for integrating with other tools and frameworks. +Warning Decimal has a limited, lower treshold (163 digits). Its possible it can overrun, hence the optional return value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func toRpcDecimal() -> Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + toNormalisedDecimal() + +
    +
    +
    +
    +
    +
    +

    Function to convert the underlying normalised value into a Decimal which can be useful in some situations for integrating with other tools and frameworks. +Warning Decimal has a limited, lower treshold (163 digits). Its possible it can overrun, hence the optional return value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func toNormalisedDecimal() -> Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + toXTZAmount() + +
    +
    +
    +
    +
    +
    +

    Currently we are unable to cast directly from TokenAmount to XTZAmount. This function will create a new XTZAmount object from the TokenAmount. +THis is useful in situations where an amount is passed in a generic manner as a TokenAmount, but its required to be an XTZAmount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func toXTZAmount() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Arithmetic +

+
+
+
    +
  • +
    + + + + +(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload + operator to allow users to add two Token amounts of the same type, together.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func + (lhs: TokenAmount, rhs: TokenAmount) -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + +=(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload += operator to allow users to add two Token amounts of the same type, together in place.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func += (lhs: inout TokenAmount, rhs: TokenAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + -(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload - operator to allow users to subtract two Token amounts of the same type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func - (lhs: TokenAmount, rhs: TokenAmount) -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + -=(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func -= (lhs: inout TokenAmount, rhs: TokenAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + *(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func * (lhs: TokenAmount, rhs: Decimal) -> Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + *(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func * (lhs: TokenAmount, rhs: Int) -> TokenAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Extensions +

+
+
+
    +
  • +
    + + + + <(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Comparable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func < (lhs: TokenAmount, rhs: TokenAmount) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: TokenAmount, rhs: TokenAmount) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TokenAmount/TokenAmountError.html b/docsets/.docset/Contents/Resources/Documents/Classes/TokenAmount/TokenAmountError.html new file mode 100644 index 00000000..3c316615 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TokenAmount/TokenAmountError.html @@ -0,0 +1,766 @@ + + + + TokenAmountError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TokenAmountError

+
+
+ +
public enum TokenAmountError : Error
+ +
+
+ +
+
+
+
    +
  • +
    + + + + invalidStringFromRPC + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidStringFromRPC
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TorusAuthService.html b/docsets/.docset/Contents/Resources/Documents/Classes/TorusAuthService.html new file mode 100644 index 00000000..6ea9cefb --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TorusAuthService.html @@ -0,0 +1,1126 @@ + + + + TorusAuthService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TorusAuthService

+
+
+ +
public class TorusAuthService : NSObject
+
extension TorusAuthService: ASAuthorizationControllerDelegate, ASAuthorizationControllerPresentationContextProviding
+ +
+
+

TorusAuthService is a wrapper around the SDK provided by: https://tor.us/ to allow the creation of TorusWallet‘s. +This allows users to create a wallet from their social media accounts without having to use a seed phrase / mnemonic. +TorusAuthService allows Tezos apps to leverage this service for a number of providers, and also has the ability to query the network for someone else’s wallet address, +based on their social profile. This allows you to send XTZ or tokens to your friend based on their twitter username for example

+ +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Setup the TorusAuthService verifiers and networking clients for testnet and mainnet, so they can be queried easier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(networkService: NetworkService, verifiers: [TorusAuthProvider : SubverifierWrapper])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + networkService + + +
    +

    A networking service instance used for converting twitter handles into twitter id’s

    +
    +
    + + verifiers + + +
    +

    List of verifiers available to the library for the given app context

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public functions +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a TorusWallet insteace from a social media provider

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func createWallet(from authType: TorusAuthProvider, displayOver: UIViewController?, mockedTorus: CustomAuth? = nil, completion: @escaping ((Result<TorusWallet, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + from + + +
    +

    The TorusAuthProvider that you want to invoke

    +
    +
    + + displayOver + + +
    +

    The UIViewController that the webpage will display on top of

    +
    +
    + + mockedTorus + + +
    +

    To avoid issues attempting to stub aspects of the Torus SDK, a mocked version of the SDK can be supplied instead

    +
    +
    + + completion + + +
    +

    The callback returned when all the networking and cryptography is complete

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a TZ2 address from a social media user name. If Twitter, will first convert the username to a userid and then query

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAddress(from authType: TorusAuthProvider, for socialUsername: String, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + from + + +
    +

    The TorusAuthProvider that you want to invoke

    +
    +
    + + for + + +
    +

    The social media username to search for

    +
    +
    + + completion + + +
    +

    The callback returned when all the networking and cryptography is complete

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Take in a Twitter username and fetch the Twitter userId instead.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func twitterLookup(username: String, completion: @escaping ((Result<String, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + username + + +
    +

    The users username. Can contain an @ symbol, but will be stripped out by the code as its not required

    +
    +
    + + completion + + +
    +

    The callback fired when the userId has been found

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TorusWallet.html b/docsets/.docset/Contents/Resources/Documents/Classes/TorusWallet.html new file mode 100644 index 00000000..f4f71b40 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TorusWallet.html @@ -0,0 +1,1010 @@ + + + + TorusWallet Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TorusWallet

+
+
+ +
public class TorusWallet : RegularWallet
+ +
+
+

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. +You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil’d when not. +In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

+ +

This wallet is a subclass of LinearWallet created by using the Torus network to generate wallets from social media accounts. +This class is equivalent to a LinearWallet producing a TZ2 address via secp256k1, without the use of a mnemonic, and instead including the social profile of the user.

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + authProvider + +
    +
    +
    +
    +
    +
    +

    The type of service used to generate the provide key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let authProvider: TorusAuthProvider
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + socialUsername + +
    +
    +
    +
    +
    +
    +

    The raw social media username displayed on the users account. In the case of Twitter, it will not be prefix with an @

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let socialUsername: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + socialUserId + +
    +
    +
    +
    +
    +
    +

    The unique id the social media platform has assigned to the users account. Used for querying account details

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let socialUserId: String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A URL to the users profile picture on the given social meida platform

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let socialProfilePictureURL: URL?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create an instace of the wallet from the data provided by the Torus network, using TorusAuthService

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(authProvider: TorusAuthProvider, username: String?, userId: String?, profilePicture: String?, torusPrivateKey: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + authProvider + + +
    +

    The supported provider used to create the private key

    +
    +
    + + username + + +
    +

    Optional, the users social profile username

    +
    +
    + + userId + + +
    +

    Optional, the users social profile unique id

    +
    +
    + + profilePicture + + +
    +

    Optional, the users social profile display image

    +
    +
    + + torusPrivateKey + + +
    +

    The hex encoded private key from the Torus network

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable +

+
+
+
    +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Encodable encode func

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TzKTClient.html b/docsets/.docset/Contents/Resources/Documents/Classes/TzKTClient.html new file mode 100644 index 00000000..a5156f42 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TzKTClient.html @@ -0,0 +1,2072 @@ + + + + TzKTClient Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTClient

+
+
+ +
public class TzKTClient
+
extension TzKTClient: HubConnectionDelegate
+ +
+
+

TzKT is an indexer for Tezos, who’s API allows developers to query details about wallets, transactions, bakers, account status etc

+ +
+
+
+
    +
  • +
    + + + + TzKTServiceError + +
    +
    +
    +
    +
    +
    +

    Unique Errors that TzKTClient can throw

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TzKTServiceError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Constants + +
    +
    +
    +
    +
    +
    +

    Constants needed for interacting with the API

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Constants
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isListening + +
    +
    +
    +
    +
    +
    +

    Is currently monitoring an address for update notifications

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isListening: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + accountDidChange + +
    +
    +
    +
    +
    +
    +

    Notifications of monitored addresses that have changed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    @Published
    +public var accountDidChange: [String] { get set }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+ +
+
+
+ + +
+ +

Storage +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get the storage of a given contract and parse it to a supplied model type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getStorage<T>(forContract contract: String, ofType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable, T : Encodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + forContract + + +
    +

    The KT1 contract address to query

    +
    +
    + + ofType + + +
    +

    The Codable compliant model to parse the response as

    +
    +
    + + completion + + +
    +

    A completion block called, returning a Swift Result type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the keys of a big map, by ID and parse it to a model

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBigMap<T>(forId id: String, ofType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable, T : Encodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + forId + + +
    +

    The numeric ID of the big map

    +
    +
    + + ofType + + +
    +

    The Codable compliant model to parse the response as

    +
    +
    + + completion + + +
    +

    A completion block called, returning a Swift Result type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the keys of a big map, but filtered to only one specific key. Parse the response as the supplied model

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBigMapKey<T>(forId id: String, key: String, ofType: T.Type, completion: @escaping ((Result<T, KukaiError>) -> Void)) where T : Decodable, T : Encodable
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + forId + + +
    +

    The numeric ID of the big map

    +
    +
    + + key + + +
    +

    The key to filter by

    +
    +
    + + ofType + + +
    +

    The Codable compliant model to parse the response as

    +
    +
    + + completion + + +
    +

    A completion block called, returning a Swift Result type

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Search +

+
+
+ +
+
+
+ + +
+ +

Baking and Rewards +

+
+
+ +
+
+
+ + +
+ +

Network +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Call https://api.tzkt.io/v1/cycles?limit=… to get the 10 most recent cycles

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func cycles(limit: Int = 25, completion: @escaping ((Result<[TzKTCycle], KukaiError>) -> Void))
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Given a list of cycles, search through them to find what cycle a given block level appeared in +If leveled supplied is less than the firstLevel of the last cycle, return the last

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func cycleForLevel(cycles: [TzKTCycle], level: Decimal) -> TzKTCycle?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Block checker +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Query details about the given operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getOperation(byHash hash: String, completion: @escaping (([TzKTOperation]?, KukaiError?) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + byHash + + +
    +

    The operation hash to query.

    +
    +
    + + completion + + +
    +

    A completion colsure called when the request is done.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Account monitoring +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Open a websocket connection to request a notification for any changes to the given account. The @Published var accountDidChange will be notified if something occurs

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func listenForAccountChanges(addresses: [String], withDebugging: Bool = false)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + address + + +
    +

    The Tz address of the account to monitor

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Close the websocket from listenForAccountChanges

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func stopListeningForAccountChanges()
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Close the current connection and open another

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func changeAddressToListenForChanges(addresses: [String])
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Balances +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Get the count of tokens the given address has balances for (excluding zero balances)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBalanceCount(forAddress: String, completion: @escaping (Result<Int, KukaiError>) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    The tz address to search for

    +
    +
    + + completion + + +
    +

    The completion block called with a Result containing the number or an error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Tokens balances and metadata need to be fetch from a paginated API. THis function calls a sinlerequest or 1 page of balances / metadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getBalancePage(forAddress: String, offset: Int = 0, completion: @escaping ((Result<[TzKTBalance], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + forAddress + + +
    +

    The tz address to search for

    +
    +
    + + offset + + +
    +

    The starting position

    +
    +
    + + completion + + +
    +

    The completion block called with a Result containing an array of balances or an error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the account object from TzKT caontaining information about the address, its balance and baker

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAccount(forAddress: String, completion: @escaping ((Result<TzKTAccount, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    The tz address to search for

    +
    +
    + + completion + + +
    +

    The completion block called with a Result containing an object or an error

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get all balances from one function call, by fetching the result from getBalanceCount and using that to decide how many pages should be called

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getAllBalances(forAddress address: String, completion: @escaping ((Result<Account, KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + forAddress + + +
    +

    The tz address to search for

    +
    +
    + + completion + + +
    +

    The completion block called with a Result containing an object or an error

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + avatarURL(forToken:) + +
    +
    +
    +
    +
    +
    +

    In order to access the cached images, you need the URL it was downloaded from. This can either be found inside the Token objects returned as part of Account from the fetchAccountInfo func. +Or, if you need to use it seperately, given the token address you can use this function

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func avatarURL(forToken token: String) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + forToken + + +
    +

    The token address who’s image you are looking for.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Transaction History +

+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TzKTClient/Constants.html b/docsets/.docset/Contents/Resources/Documents/Classes/TzKTClient/Constants.html new file mode 100644 index 00000000..efba39b3 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TzKTClient/Constants.html @@ -0,0 +1,767 @@ + + + + Constants Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Constants

+
+
+ +
public struct Constants
+ +
+
+

Constants needed for interacting with the API

+ +
+
+
+
    +
  • +
    + + + + tokenBalanceQuerySize + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tokenBalanceQuerySize: Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/TzKTClient/TzKTServiceError.html b/docsets/.docset/Contents/Resources/Documents/Classes/TzKTClient/TzKTServiceError.html new file mode 100644 index 00000000..cbc7c74d --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/TzKTClient/TzKTServiceError.html @@ -0,0 +1,793 @@ + + + + TzKTServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTServiceError

+
+
+ +
public enum TzKTServiceError : Error
+ +
+
+

Unique Errors that TzKTClient can throw

+ +
+
+
+
    +
  • +
    + + + + invalidURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidURL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseError(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parseError(String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/WalletCacheService.html b/docsets/.docset/Contents/Resources/Documents/Classes/WalletCacheService.html new file mode 100644 index 00000000..34aef45f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/WalletCacheService.html @@ -0,0 +1,1369 @@ + + + + WalletCacheService Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletCacheService

+
+
+ +
public class WalletCacheService
+ +
+
+

A service class used to store and retrieve Wallet objects such as RegularWallet, HDWallet, LedgerWallet and TorusWallet from the devices disk. +This class will use the secure enclave (keychain if not available) to generate a key used to encrypt the contents locally, and retrieve. +This class will also store non senstiivve “metadata” about wallets, to allow storage of UI related data users might want to add, without cluttering up the wallet objects themselves

+ +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    +

    Empty

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init()
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Storage and Retrieval +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Securely cache a walelt object, and record a default metadata object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func cache<T>(wallet: T, childOfIndex: Int?, backedUp: Bool) -> Bool where T : Wallet
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + wallet + + +
    +

    An object conforming to Wallet to be stored

    +
    +
    + + childOfIndex + + +
    +

    An optional Int to denote the index of the HD wallet that this wallet is a child of

    +
    +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the storage was successful or not

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Cahce a watch wallet metadata obj, only. Metadata cahcing handled via wallet cache method

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func cacheWatchWallet(metadata: WalletMetadata) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Delete both a secure wallet entry and its related metadata object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteWallet(withAddress: String, parentIndex: Int?) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + withAddress + + +
    +

    The address of the wallet

    +
    +
    + + parentIndex + + +
    +

    An optional Int to denote the index of the HD wallet that this wallet is a child of

    +
    +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the storage was successful or not

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Clear a watch wallet meatadata obj from the metadata cache only, does not affect actual wallet cache

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteWatchWallet(address: String) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Find and return the secure object for a given address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func fetchWallet(forAddress address: String) -> Wallet?
    + +
    +
    +
    +

    Return Value

    +

    Optional object confirming to Wallet protocol

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Delete the cached files and the assoicate keys used to encrypt it

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteAllCacheAndKeys() -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the process was successful or not

    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Read and Write +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Take a dictionary of Wallet objects with their addresses as the key, serialise to JSON, encrypt and then write to disk

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encryptAndWriteWalletsToDisk(wallets: [String : Wallet]) -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if the process was successful

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Go to the file on disk (if present), decrypt its contents and retrieve a dictionary of `Wallet’s with the key being the wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func readWalletsFromDiskAndDecrypt() -> [String : Wallet]?
    + +
    +
    +
    +

    Return Value

    +

    A dictionary of Wallet if present on disk

    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Write an ordered array of WalletMetadata to disk, replacing existing file if exists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encryptAndWriteMetadataToDisk(_ metadata: WalletMetadataList) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return an ordered array of WalletMetadata if present on disk

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func readMetadataFromDiskAndDecrypt() -> WalletMetadataList
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Encryption +

+
+
+
    +
  • +
    + + + + loadOrCreateKeys() + +
    +
    +
    +
    +
    +
    +

    Load the key references from the secure enclave (or keychain), or create them if non exist

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func loadOrCreateKeys() -> Bool
    + +
    +
    +
    +

    Return Value

    +

    Bool, indicating if operation was successful

    +
    +
    +
    +
  • +
  • +
    + + + + unloadKeys() + +
    +
    +
    +
    +
    +
    +

    Clear the key refrences

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func unloadKeys()
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + deleteKey() + +
    +
    +
    +
    +
    +
    +

    Delete a key from the secure enclave

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func deleteKey() throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encrypt(_:) + +
    +
    +
    +
    +
    +
    +

    Encrypts string using the Secure Enclave

    +
    +

    Throws

    + CryptoKit error + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encrypt(_ string: String) throws -> Data
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + string + + +
    +

    clear text to be encrypted

    +
    +
    +
    +
    +

    Return Value

    +

    cipherText encrypted string

    +
    +
    +
    +
  • +
  • +
    + + + + decrypt(_:) + +
    +
    +
    +
    +
    +
    +

    Decrypts cipher text using the Secure Enclave

    +
    +

    Throws

    + CryptoKit error + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func decrypt(_ cipherText: Data) throws -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cipherText + + +
    +

    encrypted cipher text

    +
    +
    +
    +
    +

    Return Value

    +

    cleartext string

    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Classes/XTZAmount.html b/docsets/.docset/Contents/Resources/Documents/Classes/XTZAmount.html new file mode 100644 index 00000000..f7c4ceb2 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Classes/XTZAmount.html @@ -0,0 +1,1169 @@ + + + + XTZAmount Class Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

XTZAmount

+
+
+ +
public class XTZAmount : TokenAmount
+ +
+
+

A subclass of TokenAmount to make it more explict when functions require XTZ (such as network fees). +It also serves as a means to more quickly create TokenAmount‘s conforming to XTZ.

+ +
+
+
+
    +
  • +
    + + + + init(fromRpcAmount:) + +
    +
    +
    +
    +
    +
    +

    Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(fromRpcAmount rpcAmount: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromRpcAmount + + +
    +

    A string conforming to the RPC standard for XTZ.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + init(fromRpcAmount:) + +
    +
    +
    +
    +
    +
    +

    Set the internal balance, using a decimal version of an RPC amount. e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(fromRpcAmount rpcAmount: Decimal)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromRpcAmount + + +
    +

    A decimal conforming to the RPC standard for XTZ. Decimal places will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(fromNormalisedAmount normalisedAmount: Decimal)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNormalisedAmount + + +
    +

    A decimal containing an amount for XTZ. Anything over the given decimal places for the token will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public convenience init?(fromNormalisedAmount normalisedAmount: String, decimalPlaces: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromNormalisedAmount + + +
    +

    A string containing an amount for XTZ. Anything over the given decimal places for the token will be ignored.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + zero() + +
    +
    +
    +
    +
    +
    +

    Quickly create a XTZAmount with zero balance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public override class func zero() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable +

+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info. +This coder attempts to handle both states, first checking if its possible to extract both, if not, defaulting the decimal palces to zero, expecting the calling application to provide this information later on from another proptery or even another API call (such as a metadata query)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    required public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Arithmetic +

+
+
+
    +
  • +
    + + + + +(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload + operator to allow users to add two Token amounts of the same type, together.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func + (lhs: XTZAmount, rhs: XTZAmount) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + +=(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload += operator to allow users to add two Token amounts of the same type, together in place.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func += (lhs: inout XTZAmount, rhs: XTZAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + -(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload - operator to allow users to subtract two Token amounts of the same type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func - (lhs: XTZAmount, rhs: XTZAmount) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + -=(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func -= (lhs: inout XTZAmount, rhs: XTZAmount)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + *(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func * (lhs: XTZAmount, rhs: Decimal) -> Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + *(_:_:) + +
    +
    +
    +
    +
    +
    +

    Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func * (lhs: XTZAmount, rhs: Int) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums.html b/docsets/.docset/Contents/Resources/Documents/Enums.html new file mode 100644 index 00000000..6c91ec6b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums.html @@ -0,0 +1,1313 @@ + + + + Enumerations Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Enumerations

+

The following enumerations are available globally.

+ +
+
+
+
    +
  • +
    + + + + ResultExtensionError + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum ResultExtensionError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupExchangeName + +
    +
    +
    +
    +
    +
    +

    Enum to wrap up the available types of Exchange on DipDup

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum DipDupExchangeName : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupTokenStandard + +
    +
    +
    +
    +
    +
    +

    Wrapping up the FA standards into an enum

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum DipDupTokenStandard : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBakerHealth + +
    +
    +
    +
    +
    +
    +

    The stability of the bakers server

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TzKTBakerHealth : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBakerAccuracy + +
    +
    +
    +
    +
    +
    +

    The accuracy of the bakers payments

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TzKTBakerAccuracy : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBakerTiming + +
    +
    +
    +
    +
    +
    +

    The reliability of the bakers payouts

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TzKTBakerTiming : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + BiometricType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum BiometricType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CurrentDevice + +
    +
    +
    +
    +
    +
    +

    Enum used to get details about the current device’s capabilities

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum CurrentDevice
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + HDWalletError + +
    +
    +
    +
    +
    +
    +

    Error types that can be passed by failable inits

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum HDWalletError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationKind + +
    +
    +
    +
    +
    +
    +

    Enum representing the various kinds of supported Operation‘s

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum OperationKind : String, Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum OperationTransactionError : Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FaVersion + +
    +
    +
    +
    +
    +
    +

    Enum representing the version of tezos “FA” token contracts

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum FaVersion : String, Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Enums +

+
+
+
    +
  • +
    + + + + WalletType + +
    +
    +
    +
    +
    +
    +

    Enum to distingush between linear (non-hd) wallets, using the Bip39 standard, and hd wallets using the Bip44 standard.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum WalletType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + WalletError + +
    +
    +
    +
    +
    +
    +

    Possible error types that can occur when using the LedgerWallet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum WalletError : Error
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum MediaProxyServiceError : String, Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CacheType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum CacheType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DAppCategory + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum DAppCategory
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DAppAccessType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum DAppAccessType
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + TorusAuthProvider + +
    +
    +
    +
    +
    +
    +

    List of providers currently supported and available on the Tezos network

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TorusAuthProvider : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TorusAuthError + +
    +
    +
    +
    +
    +
    +

    Custom TorusAuthService errors that cna be thrown

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TorusAuthError : Error
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/BiometricType.html b/docsets/.docset/Contents/Resources/Documents/Enums/BiometricType.html new file mode 100644 index 00000000..ccd1c9b2 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/BiometricType.html @@ -0,0 +1,844 @@ + + + + BiometricType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BiometricType

+
+
+ +
public enum BiometricType
+ +
+
+ +
+
+
+
    +
  • +
    + + + + unavailable + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unavailable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case none
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + touchID + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case touchID
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + faceID + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case faceID
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/CacheType.html b/docsets/.docset/Contents/Resources/Documents/Enums/CacheType.html new file mode 100644 index 00000000..4d74642f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/CacheType.html @@ -0,0 +1,792 @@ + + + + CacheType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

CacheType

+
+
+ +
public enum CacheType
+ +
+
+ +
+
+
+
    +
  • +
    + + + + temporary + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case temporary
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + permanent + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case permanent
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/CurrentDevice.html b/docsets/.docset/Contents/Resources/Documents/Enums/CurrentDevice.html new file mode 100644 index 00000000..f6b100f4 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/CurrentDevice.html @@ -0,0 +1,820 @@ + + + + CurrentDevice Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

CurrentDevice

+
+
+ +
public enum CurrentDevice
+ +
+
+

Enum used to get details about the current device’s capabilities

+ +
+
+
+
    +
  • +
    + + + + isSimulator + +
    +
    +
    +
    +
    +
    +

    Is the current device a simulator

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static var isSimulator: Bool { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func biometricTypeAuthorized() -> BiometricType
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func biometricTypeSupported() -> BiometricType
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/DAppAccessType.html b/docsets/.docset/Contents/Resources/Documents/Enums/DAppAccessType.html new file mode 100644 index 00000000..b6c63581 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/DAppAccessType.html @@ -0,0 +1,818 @@ + + + + DAppAccessType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DAppAccessType

+
+
+ +
public enum DAppAccessType
+ +
+
+ +
+
+
+
    +
  • +
    + + + + all + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case all
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + directAuthOnly + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case directAuthOnly
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case none
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/DAppCategory.html b/docsets/.docset/Contents/Resources/Documents/Enums/DAppCategory.html new file mode 100644 index 00000000..0ea315b9 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/DAppCategory.html @@ -0,0 +1,818 @@ + + + + DAppCategory Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DAppCategory

+
+
+ +
public enum DAppCategory
+ +
+
+ +
+
+
+
    +
  • +
    + + + + marketplace + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case marketplace
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchange + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case exchange
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + collectible + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case collectible
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/DipDupExchangeName.html b/docsets/.docset/Contents/Resources/Documents/Enums/DipDupExchangeName.html new file mode 100644 index 00000000..d8082c21 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/DipDupExchangeName.html @@ -0,0 +1,845 @@ + + + + DipDupExchangeName Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupExchangeName

+
+
+ +
public enum DipDupExchangeName : String, Codable
+ +
+
+

Enum to wrap up the available types of Exchange on DipDup

+ +
+
+
+
    +
  • +
    + + + + quipuswap + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case quipuswap
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lb + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case lb
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/DipDupTokenStandard.html b/docsets/.docset/Contents/Resources/Documents/Enums/DipDupTokenStandard.html new file mode 100644 index 00000000..39ab5321 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/DipDupTokenStandard.html @@ -0,0 +1,845 @@ + + + + DipDupTokenStandard Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupTokenStandard

+
+
+ +
public enum DipDupTokenStandard : String, Codable
+ +
+
+

Wrapping up the FA standards into an enum

+ +
+
+
+
    +
  • +
    + + + + fa12 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fa12
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fa2 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fa2
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/FaVersion.html b/docsets/.docset/Contents/Resources/Documents/Enums/FaVersion.html new file mode 100644 index 00000000..2cbb27d6 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/FaVersion.html @@ -0,0 +1,845 @@ + + + + FaVersion Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FaVersion

+
+
+ +
public enum FaVersion : String, Codable
+ +
+
+

Enum representing the version of tezos “FA” token contracts

+ +
+
+
+
    +
  • +
    + + + + fa1_2 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fa1_2 = "fa1.2"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fa2 + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fa2
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/HDWalletError.html b/docsets/.docset/Contents/Resources/Documents/Enums/HDWalletError.html new file mode 100644 index 00000000..2e404c00 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/HDWalletError.html @@ -0,0 +1,767 @@ + + + + HDWalletError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

HDWalletError

+
+
+ +
public enum HDWalletError : Error
+ +
+
+

Error types that can be passed by failable inits

+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidWalletCoreWallet
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/MediaProxyServiceError.html b/docsets/.docset/Contents/Resources/Documents/Enums/MediaProxyServiceError.html new file mode 100644 index 00000000..7f5877ab --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/MediaProxyServiceError.html @@ -0,0 +1,792 @@ + + + + MediaProxyServiceError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

MediaProxyServiceError

+
+
+ +
public enum MediaProxyServiceError : String, Error
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noMimeTypeFoundInsideFormats
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unableToParseContentType
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/OperationKind.html b/docsets/.docset/Contents/Resources/Documents/Enums/OperationKind.html new file mode 100644 index 00000000..ceb9da07 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/OperationKind.html @@ -0,0 +1,1145 @@ + + + + OperationKind Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationKind

+
+
+ +
public enum OperationKind : String, Codable
+ +
+
+

Enum representing the various kinds of supported Operation‘s

+ +
+
+
+
    +
  • +
    + + + + transaction + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case transaction
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reveal + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case reveal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case delegation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + origination + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case origination
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + activate_account + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case activate_account
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endorsement + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case endorsement
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + seed_nonce_revelation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case seed_nonce_revelation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case double_endorsement_evidence
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case double_baking_evidence
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proposals + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case proposals
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ballot + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ballot
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    +

    Create a base operation.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + from + + +
    +

    A decoder used to convert a data fromat (such as JSON) into the model object.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    +

    Convert the object into a data format, such as JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + to + + +
    +

    An encoder that will allow conversions to multipel data formats.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/OperationTransactionError.html b/docsets/.docset/Contents/Resources/Documents/Enums/OperationTransactionError.html new file mode 100644 index 00000000..2d00d890 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/OperationTransactionError.html @@ -0,0 +1,766 @@ + + + + OperationTransactionError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationTransactionError

+
+
+ +
public enum OperationTransactionError : Error
+ +
+
+ +
+
+
+
    +
  • +
    + + + + invalidMichelsonValue + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidMichelsonValue
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/ResultExtensionError.html b/docsets/.docset/Contents/Resources/Documents/Enums/ResultExtensionError.html new file mode 100644 index 00000000..50c80435 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/ResultExtensionError.html @@ -0,0 +1,766 @@ + + + + ResultExtensionError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ResultExtensionError

+
+
+ +
public enum ResultExtensionError : Error
+ +
+
+ +
+
+
+
    +
  • +
    + + + + noErrorFound + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noErrorFound
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/TorusAuthError.html b/docsets/.docset/Contents/Resources/Documents/Enums/TorusAuthError.html new file mode 100644 index 00000000..cc0de7d3 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/TorusAuthError.html @@ -0,0 +1,923 @@ + + + + TorusAuthError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TorusAuthError

+
+
+ +
public enum TorusAuthError : Error
+ +
+
+

Custom TorusAuthService errors that cna be thrown

+ +
+
+
+
    +
  • +
    + + + + missingVerifier + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case missingVerifier
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidTorusResponse + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidTorusResponse
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + cryptoError + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case cryptoError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidNodeDetails + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidNodeDetails
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidTwitterURL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidTwitterURL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + noTwiiterUserIdFound + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case noTwiiterUserIdFound
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + invalidAppleResponse + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case invalidAppleResponse
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/TorusAuthProvider.html b/docsets/.docset/Contents/Resources/Documents/Enums/TorusAuthProvider.html new file mode 100644 index 00000000..e5ac44c6 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/TorusAuthProvider.html @@ -0,0 +1,975 @@ + + + + TorusAuthProvider Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TorusAuthProvider

+
+
+ +
public enum TorusAuthProvider : String, Codable
+ +
+
+

List of providers currently supported and available on the Tezos network

+ +
+
+
+
    +
  • +
    + + + + apple + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case apple
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + google + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case google
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + facebook + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case facebook
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case twitter
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reddit + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case reddit
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + discord + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case discord
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitch + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case twitch
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + line + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case line
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + github + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case github
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/TzKTBakerAccuracy.html b/docsets/.docset/Contents/Resources/Documents/Enums/TzKTBakerAccuracy.html new file mode 100644 index 00000000..e52ad5e6 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/TzKTBakerAccuracy.html @@ -0,0 +1,845 @@ + + + + TzKTBakerAccuracy Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerAccuracy

+
+
+ +
public enum TzKTBakerAccuracy : String, Codable
+ +
+
+

The accuracy of the bakers payments

+ +
+
+
+
    +
  • +
    + + + + precise + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case precise
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + inaccurate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case inaccurate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + suspicious + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case suspicious
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + no_data + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case no_data
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/TzKTBakerHealth.html b/docsets/.docset/Contents/Resources/Documents/Enums/TzKTBakerHealth.html new file mode 100644 index 00000000..e55e5ea8 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/TzKTBakerHealth.html @@ -0,0 +1,819 @@ + + + + TzKTBakerHealth Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerHealth

+
+
+ +
public enum TzKTBakerHealth : String, Codable
+ +
+
+

The stability of the bakers server

+ +
+
+
+
    +
  • +
    + + + + active + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case active
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + closed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case closed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + dead + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case dead
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/TzKTBakerTiming.html b/docsets/.docset/Contents/Resources/Documents/Enums/TzKTBakerTiming.html new file mode 100644 index 00000000..4729553b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/TzKTBakerTiming.html @@ -0,0 +1,845 @@ + + + + TzKTBakerTiming Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerTiming

+
+
+ +
public enum TzKTBakerTiming : String, Codable
+ +
+
+

The reliability of the bakers payouts

+ +
+
+
+
    +
  • +
    + + + + stable + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case stable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unstable + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unstable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + suspicious + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case suspicious
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + no_data + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case no_data
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/WalletError.html b/docsets/.docset/Contents/Resources/Documents/Enums/WalletError.html new file mode 100644 index 00000000..cbe1c5c2 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/WalletError.html @@ -0,0 +1,767 @@ + + + + WalletError Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletError

+
+
+ +
public enum WalletError : Error
+ +
+
+

Possible error types that can occur when using the LedgerWallet

+ +
+
+
+
    +
  • +
    + + + + signatureError + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case signatureError
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Enums/WalletType.html b/docsets/.docset/Contents/Resources/Documents/Enums/WalletType.html new file mode 100644 index 00000000..df43bc4b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Enums/WalletType.html @@ -0,0 +1,845 @@ + + + + WalletType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletType

+
+
+ +
public enum WalletType : String, Codable
+ +
+
+

Enum to distingush between linear (non-hd) wallets, using the Bip39 standard, and hd wallets using the Bip44 standard.

+ +
+
+
+
    +
  • +
    + + + + regular + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case regular
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hd + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case hd
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + social + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case social
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ledger + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case ledger
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions.html b/docsets/.docset/Contents/Resources/Documents/Extensions.html new file mode 100644 index 00000000..d2450608 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions.html @@ -0,0 +1,1167 @@ + + + + Extensions Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Extensions

+

The following extensions are available globally.

+ +
+
+
+
    +
  • +
    + + + + Collection + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Collection
    +
    public extension Collection where Element: Publisher
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Date + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Date
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DateFormatter + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension DateFormatter
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Decimal + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Error + +
    +
    +
    +
    +
    +
    +

    Exposing underlying NSError properties not accessible to Swift Error without casting

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Logger + +
    +
    +
    +
    +
    +
    +

    Extension to OSLog to create some custom categories for logging

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Publisher + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Publisher
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + AnyPublisher + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension AnyPublisher
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Result + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Result
    +
    public extension Result where Failure == KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + String + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Thread + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Thread
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NSImage + +
    +
    +
    +
    +
    +
    +

    Create standard UIImage properties and methods

    + + See more +
    +
    +
    +
  • +
  • +
    + + + + LossyCodableList + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    extension LossyCodableList: Decodable where Element: Decodable
    +
    extension LossyCodableList: Encodable where Element: Encodable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Dictionary + +
    +
    +
    +
    +
    +
    +

    Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Dictionary where Key == String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + Array + +
    +
    +
    +
    +
    +
    +

    Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension Array where Element == [String: Any]
    +
    public extension Array where Element == Any
    +
    extension Array where Element == Operation
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public extension KeyedDecodingContainer
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/AnyPublisher.html b/docsets/.docset/Contents/Resources/Documents/Extensions/AnyPublisher.html new file mode 100644 index 00000000..cfc9a7fc --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/AnyPublisher.html @@ -0,0 +1,848 @@ + + + + AnyPublisher Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

AnyPublisher

+
+
+ +
public extension AnyPublisher
+ +
+
+ +
+
+
+
    +
  • +
    + + + + just(_:) + +
    +
    +
    +
    +
    +
    +

    Helper for returning a Just publisher, with the appropriate Failure type and erased to AnyPublisher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static func just(_ output: Output) -> AnyPublisher<Output, Failure>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fail(with:) + +
    +
    +
    +
    +
    +
    +

    Helper for returning a Fail publisher, erased to AnyPublisher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static func fail(with error: Failure) -> AnyPublisher<Output, Failure>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + onReceiveOutput(_:) + +
    +
    +
    +
    +
    +
    +

    Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func onReceiveOutput(_ callback: @escaping ((`Self`.Output) -> Void)) -> Publishers.HandleEvents<`Self`>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func sink(onError: @escaping ((Failure) -> Void), onSuccess: @escaping ((Output) -> Void), onComplete: (() -> Void)? = nil) -> AnyCancellable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Array.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Array.html new file mode 100644 index 00000000..f91c5ef3 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Array.html @@ -0,0 +1,988 @@ + + + + Array Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Array

+
+
+ +
public extension Array where Element == [String: Any]
+
public extension Array where Element == Any
+
extension Array where Element == Operation
+ +
+
+

Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

+ +
+
+
+
+ + +
+ +

Available where Element == [String: Any] +

+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonInt(atIndex index: Int) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonString(atIndex index: Int) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonPair(atIndex index: Int) -> [String : Any]?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Element == Any +

+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonInt(atIndex index: Int) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonString(atIndex index: Int) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonPair(atIndex index: Int) -> [String : Any]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonArray(atIndex index: Int) -> [Any]?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Element == Operation +

+
+
+
    +
  • +
    + + + + copyOperations() + +
    +
    +
    +
    +
    +
    +

    Operation’s are classes, passed by reference, but often require making copies so that you can manipulate them before sending to be estimated. +Function make it easy by converting the array to JSON and recreating, avoiding issues where construnctors manipulate inputs before storing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func copyOperations() -> [Operation]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Collection.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Collection.html new file mode 100644 index 00000000..7c87e84b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Collection.html @@ -0,0 +1,808 @@ + + + + Collection Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Collection

+
+
+ +
public extension Collection
+
public extension Collection where Element: Publisher
+ +
+
+ +
+
+
+
    +
  • +
    + + + + subscript(safe:) + +
    +
    +
    +
    +
    +
    +

    Returns the element at the specified index if it is within bounds, otherwise nil.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    subscript(safe index: Index) -> Element? { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Element: Publisher +

+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Date.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Date.html new file mode 100644 index 00000000..4933cbcf --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Date.html @@ -0,0 +1,767 @@ + + + + Date Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Date

+
+
+ +
public extension Date
+ +
+
+ +
+
+
+
    +
  • +
    + + + + timeAgoDisplay() + +
    +
    +
    +
    +
    +
    +

    Helper to return strings like “15 seconds ago”, “1 minute ago” etc, from a Date

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func timeAgoDisplay() -> String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/DateFormatter.html b/docsets/.docset/Contents/Resources/Documents/Extensions/DateFormatter.html new file mode 100644 index 00000000..9f46f2d1 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/DateFormatter.html @@ -0,0 +1,767 @@ + + + + DateFormatter Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DateFormatter

+
+
+ +
public extension DateFormatter
+ +
+
+ +
+
+
+
    +
  • +
    + + + + init(withFormat:) + +
    +
    +
    +
    +
    +
    +

    Helper to create a DateFormatter with a format in 1 call

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    convenience init(withFormat: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Decimal.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Decimal.html new file mode 100644 index 00000000..8f65e012 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Decimal.html @@ -0,0 +1,794 @@ + + + + Decimal Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Decimal

+
+
+ +
public extension Decimal
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Wrapper around the Objective-c code needed to round a Decimal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func rounded(scale: Int, roundingMode: NSDecimalNumber.RoundingMode) -> Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + intValue() + +
    +
    +
    +
    +
    +
    +

    Wrapper around the Objective-c code needed to return an Int from a decimal

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func intValue() -> Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Dictionary.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Dictionary.html new file mode 100644 index 00000000..ec37b590 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Dictionary.html @@ -0,0 +1,906 @@ + + + + Dictionary Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Dictionary

+
+
+ +
public extension Dictionary where Key == String
+ +
+
+

Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

+ +
+
+
+
+ + +
+ +

Available where Key == String +

+
+
+
    +
  • +
    + + + + michelsonValue() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonValue() -> [String : Any]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonValueArray() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonValueArray() -> [[String : Any]]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonArgsArray() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonArgsArray() -> [[String : Any]]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonArgsUnknownArray() -> [Any]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonInt() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonInt() -> String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + michelsonString() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func michelsonString() -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Error.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Error.html new file mode 100644 index 00000000..8134b863 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Error.html @@ -0,0 +1,849 @@ + + + + Error Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Error

+
+
+ +
public extension Error
+ +
+
+

Exposing underlying NSError properties not accessible to Swift Error without casting

+ +
+
+
+
    +
  • +
    + + + + code + +
    +
    +
    +
    +
    +
    +

    Access NSError.code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var code: Int { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + domain + +
    +
    +
    +
    +
    +
    +

    Access NSError.domain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var domain: String { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + userInfo + +
    +
    +
    +
    +
    +
    +

    Access NSError.userInfo

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var userInfo: [String : Any] { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + underlyingError + +
    +
    +
    +
    +
    +
    +

    Access NSError.userInfo[NSUnderlyingErrorKey] and cast to swift Error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var underlyingError: NSError? { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/KeyedDecodingContainer.html b/docsets/.docset/Contents/Resources/Documents/Extensions/KeyedDecodingContainer.html new file mode 100644 index 00000000..34f7d87b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/KeyedDecodingContainer.html @@ -0,0 +1,793 @@ + + + + KeyedDecodingContainer Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

KeyedDecodingContainer

+
+
+ +
public extension KeyedDecodingContainer
+ +
+
+ +
+
+
+
    +
  • +
    + + + + decode(_:forKey:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func decode<T>(_ type: NilOnDecodingError<T>.Type, forKey key: `Self`.Key) throws -> NilOnDecodingError<T> where T : Decodable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    In case where people have not followed the spec correctly, and named keys slightly differently, allow a second key to be used so that, for example, we could check for artifcatUri or artifact_uri in one call

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func decodeIfPresent<T>(_ type: T.Type, forKey key: `Self`.Key, orBackupKey: `Self`.Key) throws -> T? where T : Decodable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Logger.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Logger.html new file mode 100644 index 00000000..d7e0feda --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Logger.html @@ -0,0 +1,1028 @@ + + + + Logger Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Logger

+
+
+ +
public extension Logger
+ +
+
+

Extension to OSLog to create some custom categories for logging

+ +
+
+
+
    +
  • +
    + + + + kukaiCoreSwift + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let kukaiCoreSwift: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + walletCache + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let walletCache: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + kukaiCoreSwiftError + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let kukaiCoreSwiftError: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + keychain + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let keychain: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + network + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let network: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bcd + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let bcd: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzkt + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let tzkt: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + taquitoService + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let taquitoService: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + torus + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let torus: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ledger + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let ledger: Logger
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + app + +
    +
    +
    +
    +
    +
    +

    Used by the app importing this library

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    static let app: Logger
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/NSImage.html b/docsets/.docset/Contents/Resources/Documents/Extensions/NSImage.html new file mode 100644 index 00000000..8e913402 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/NSImage.html @@ -0,0 +1,770 @@ + + + + NSImage Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NSImage

+

Create standard UIImage properties and methods

+ +
+
+
+
    +
  • +
    + + + + cgImage + +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
  • +
  • +
    + + + + init(named:) + +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Publisher.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Publisher.html new file mode 100644 index 00000000..e22a9d9f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Publisher.html @@ -0,0 +1,875 @@ + + + + Publisher Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Publisher

+
+
+ +
public extension Publisher
+ +
+
+ +
+
+
+
    +
  • +
    + + + + asFuture() + +
    +
    +
    +
    +
    +
    +

    Wrap a Publisher in a Future of type <Output, Never>

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func asFuture() -> Future<Output, Never>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + asDeferredFuture() + +
    +
    +
    +
    +
    +
    +

    Wrap a Publisher in a Deferred Future of type <Output, Never>

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func asDeferredFuture() -> Deferred<Future<Output, Never>>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + convertToResult() + +
    +
    +
    +
    +
    +
    +

    Convert a publisher output into a swift Resultobject to make handling sink‘s easier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func convertToResult() -> AnyPublisher<Result<Output, Failure>, Never>
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + onReceiveOutput(_:) + +
    +
    +
    +
    +
    +
    +

    Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func onReceiveOutput(_ callback: @escaping ((Self.Output) -> Void)) -> Publishers.HandleEvents<Self>
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func sink(onError: @escaping ((Failure) -> Void), onSuccess: @escaping ((Output) -> Void), onComplete: (() -> Void)? = nil) -> AnyCancellable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Result.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Result.html new file mode 100644 index 00000000..c930633a --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Result.html @@ -0,0 +1,808 @@ + + + + Result Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Result

+
+
+ +
public extension Result
+
public extension Result where Failure == KukaiError
+ +
+
+ +
+
+
+
    +
  • +
    + + + + getError() + +
    +
    +
    +
    +
    +
    +

    Similar to Result.get(), getError returns the failure case or throws

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func getError() throws -> Failure
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Failure == KukaiError +

+
+
+
    +
  • +
    + + + + getFailure() + +
    +
    +
    +
    +
    +
    +

    Similar to Result.get(), getFailure returns the kukai-core-specific KukaiError case or throws

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func getFailure() -> Failure
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/String.html b/docsets/.docset/Contents/Resources/Documents/Extensions/String.html new file mode 100644 index 00000000..b2b25185 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/String.html @@ -0,0 +1,794 @@ + + + + String Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

String

+
+
+ +
public extension String
+ +
+
+ +
+
+
+
    +
  • +
    + + + + indexesOf(string:) + +
    +
    +
    +
    +
    +
    +

    Return the starting indexes of each occurnace of the supplied string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func indexesOf(string: String) -> [String.Index]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    When an error is returned in the format proto.012-Psithaca.gas_exhausted.operation, in many cases we only care about the bit after the protocol. This function returns only that piece

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func removeLeadingProtocolFromRPCError() -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Extensions/Thread.html b/docsets/.docset/Contents/Resources/Documents/Extensions/Thread.html new file mode 100644 index 00000000..fe5adf4e --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Extensions/Thread.html @@ -0,0 +1,767 @@ + + + + Thread Extension Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Thread

+
+
+ +
public extension Thread
+ +
+
+ +
+
+
+
    +
  • +
    + + + + isRunningXCTest + +
    +
    +
    +
    +
    +
    +

    Check if the given thread is being run from inside an XCTest bundle

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var isRunningXCTest: Bool { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Protocols.html b/docsets/.docset/Contents/Resources/Documents/Protocols.html new file mode 100644 index 00000000..ed29b185 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Protocols.html @@ -0,0 +1,803 @@ + + + + Protocols Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Protocols

+

The following protocols are available globally.

+ +
+
+
+
    +
  • +
    + + + + FailWithParser + +
    +
    +
    +
    +
    +
    +

    Protocol to allow defining multiple dedicated structs, one for each dApp, that knows how to convert the specific failWith cases into more human readable error messages

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public protocol FailWithParser
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Protocols +

+
+
+
    +
  • +
    + + + + Wallet + +
    +
    +
    +
    +
    +
    +

    Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public protocol Wallet : Decodable, Encodable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Protocols/FailWithParser.html b/docsets/.docset/Contents/Resources/Documents/Protocols/FailWithParser.html new file mode 100644 index 00000000..086d888e --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Protocols/FailWithParser.html @@ -0,0 +1,768 @@ + + + + FailWithParser Protocol Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FailWithParser

+
+
+ +
public protocol FailWithParser
+ +
+
+

Protocol to allow defining multiple dedicated structs, one for each dApp, that knows how to convert the specific failWith cases into more human readable error messages

+ +
+
+
+
    +
  • +
    + + + + parse(failWith:) + +
    +
    +
    +
    +
    +
    +

    Take in a failWith and return a message

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func parse(failWith: FailWith?) -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Protocols/Wallet.html b/docsets/.docset/Contents/Resources/Documents/Protocols/Wallet.html new file mode 100644 index 00000000..f708bdb0 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Protocols/Wallet.html @@ -0,0 +1,907 @@ + + + + Wallet Protocol Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Wallet

+
+
+ +
public protocol Wallet : Decodable, Encodable
+ +
+
+

Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    Which underlying WalletType is the wallet using

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var type: WalletType { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The public TZ1 or TZ2 address of the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var address: String { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Sign a hex string with the wallets private key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func sign(_ hex: String, isOperation: Bool, completion: @escaping ((Result<[UInt8], KukaiError>) -> Void))
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + hex + + +
    +

    A hex encoded string, representing a forged operation payload.

    +
    +
    + + completion + + +
    +

    A completion block to run with the resulting signature, needs to be done async in order to support usecases such as signing with an external ledger.

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + privateKeyCurve() + +
    +
    +
    +
    +
    +
    +

    Query which curve the given wallet is using

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func privateKeyCurve() -> EllipticalCurve
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Base58 encoded version of the publicKey, used when performing a reveal operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    func publicKeyBase58encoded() -> String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs.html b/docsets/.docset/Contents/Resources/Documents/Structs.html new file mode 100644 index 00000000..33cac02c --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs.html @@ -0,0 +1,3421 @@ + + + + Structures Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Structures

+

The following structures are available globally.

+ +
+
+
+
    +
  • +
    + + + + Account + +
    +
    +
    +
    +
    +
    +

    Fetching all the account balances is a lengthy task, involving many requests and parsing different structures. +This struct abstract the developer away from knowing all these details, and instead allows developers to access wallets balances in a more normal approach

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct Account : Codable, Hashable
    +
    extension Account: Identifiable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object ot abstract away a significatn amount of logic involved in computing estimated reward payments from a baker

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct AggregateRewardInformation : Codable, Hashable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + RewardDetails + +
    +
    +
    +
    +
    +
    +

    An individual payment record denoting some payment in the past or future

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct RewardDetails : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A model matching the response that comes back from BetterCallDev’s API: v1/opg/<operation-hash>

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BetterCallDevOperation : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    BetterCallDev structure for errors

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BetterCallDevOperationError : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupChartData + +
    +
    +
    +
    +
    +
    +

    Struct to hold 4 arrays of data, each one mapping to a different timeline of data, to allow the display of graphs

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupChartData : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupChartObject + +
    +
    +
    +
    +
    +
    +

    Structure holding a data slice

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupChartObject : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper object to map to network response type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupExchangesAndTokensResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper object to map to network response type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupExchangesAndTokens : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupExchange + +
    +
    +
    +
    +
    +
    +

    A DipDup Exchange object with all the necessary pieces for checking liquidity and performing Swaps

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupExchange : Codable, Hashable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupPosition + +
    +
    +
    +
    +
    +
    +

    Wrapper object to match network response type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupPosition : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupPositionData + +
    +
    +
    +
    +
    +
    +

    A position on DipDup corresponds to liquidity token ownership. Each of these objects represents an amount of Liquidity tokens in an exchange for the given address

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupPositionData : Codable, Hashable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DipDupToken + +
    +
    +
    +
    +
    +
    +

    DipDup representation of a Token

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DipDupToken : Codable, Hashable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTAccount + +
    +
    +
    +
    +
    +
    +

    Model mapping to TzKT.io’s Account object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTAccount : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTAccountDelegate + +
    +
    +
    +
    +
    +
    +

    Model mapping to TzKT.io’s Account.Delegate Object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTAccountDelegate : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTAddress + +
    +
    +
    +
    +
    +
    +

    Details about a given contract

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTAddress : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBaker + +
    +
    +
    +
    +
    +
    +

    Data representing a baker from TzKT or Baking-Bad

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBaker : Codable, Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBakerConfig + +
    +
    +
    +
    +
    +
    +

    The bakers config file for details on when fees, min delegation etc change

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBakerConfig : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBakerConfigDoubleValue : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBakerConfigIntValue : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Baker config payout flags

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBakerConfigRewardStruct : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBalance + +
    +
    +
    +
    +
    +
    +

    Model mapping to the Balance object returned from the new TzKT API, resulting from the merge of BCD and TzKT

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalance : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBalanceToken + +
    +
    +
    +
    +
    +
    +

    Model encapsulating information about the token itself

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceToken : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTBalanceMetadata + +
    +
    +
    +
    +
    +
    +

    Metadata object for the token

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceMetadata : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper / Helper to extract metadata attribute content

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceMetadataAttributeKeyValue : Codable, Hashable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object containing information about the various formats the media is available in

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceMetadataFormat : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object containing information about the dimensions of a given piece of media

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTBalanceMetadataDimensions : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTCycle + +
    +
    +
    +
    +
    +
    +

    The blockchain is broken down into cycles that last 2.7 days. Baker payment logic resolves around cycles instead of blocks

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTCycle : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTDelegatorReward + +
    +
    +
    +
    +
    +
    +

    An object containing info on the reward a delegator should receive from a baker

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTDelegatorReward : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTOperation + +
    +
    +
    +
    +
    +
    +

    A model matching the response that comes back from TzKT’s API: v1/operations/<operation-hash>

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTOperation : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTOperationError + +
    +
    +
    +
    +
    +
    +

    TzKT’s more basic error object response

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTOperationError : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTTokenTransfer + +
    +
    +
    +
    +
    +
    +

    FA1.2 / FA2 token transafers are treated differently from transactions. This object is used when fetching data form the API, as a temporary placeholder, ultimately to be merged into the transactions

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTTokenTransfer : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTTransaction + +
    +
    +
    +
    +
    +
    +

    A model matching the response that comes back from TzKT’s API: v1/accounts/<address>/operations

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTTransaction : Codable, CustomStringConvertible, Hashable, Identifiable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TzKTTransactionGroup + +
    +
    +
    +
    +
    +
    +

    Artifical object used to group related transactions into a more user friendly display +For example, 1 contract call can reuslt in many transactions being returned. To avoid the users UI being clogged, we group all them into 1 group, so the user only needs to see 1 item for 1 action they performed

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TzKTTransactionGroup : Codable, Hashable, Identifiable, CustomStringConvertible
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + BlockchainHead + +
    +
    +
    +
    +
    +
    +

    Structure representing the HEAD of the blockchain

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BlockchainHead : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LoggingConfig + +
    +
    +
    +
    +
    +
    +

    A struct to control what messages get logged

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct LoggingConfig
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosNodeClientConfig + +
    +
    +
    +
    +
    +
    +

    A configuration object used to provide settings to the TezosNodeClient

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosNodeClientConfig
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The gneric container object holding the raw data

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeLedgerKey : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The unique data inside the Ledger BigMap

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeLedger : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Network wrapper object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeStorageResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Unique Quipuswap contract storage object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeStorage : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The gneric container object holding the raw data

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeUserRewardsKey : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The unique data inside the User Rewards BigMap

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct QuipuswapExchangeUserRewards : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Dedicated “FailWith” parser for the codes received from Liquidity Baking contract

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct FailWithParserLiquidityBaking : FailWithParser
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + GraphQLError + +
    +
    +
    +
    +
    +
    +

    GraphQL error object

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct GraphQLError : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + GraphQLResponse + +
    +
    +
    +
    +
    +
    +

    Simple model object to wrap a GraphQL response to expose a Codable response without having to use large GraphQL libraries

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct GraphQLResponse<T> : Codable where T : Decodable, T : Encodable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktCollections + +
    +
    +
    +
    +
    +
    +

    GarpQL bulk response for a group of collections

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktCollections : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktCollection + +
    +
    +
    +
    +
    +
    +

    Single collection item

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktCollection : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktCreator + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktCreator : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktTokenReponse + +
    +
    +
    +
    +
    +
    +

    GarpQL response for required data for a given token

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktTokenReponse : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktToken + +
    +
    +
    +
    +
    +
    +

    Single token item

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktToken : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktAttribute + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktAttribute : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktAttributeData + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktAttributeData : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktAttributeCounts + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktAttributeCounts : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktSale + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktSale : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktListing + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktListing : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktEvent + +
    +
    +
    +
    +
    +
    +

    Single event item

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktEvent : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ObjktFa + +
    +
    +
    +
    +
    +
    +

    Single FA item

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct ObjktFa : Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Domain +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Response object wrapper for querying an address in bulk

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsAddressBulkResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosDomainsDomains + +
    +
    +
    +
    +
    +
    +

    Object containing an array of domains

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsDomains : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Response object wrapper for querying an address

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsAddressResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TezosDomainsDomain + +
    +
    +
    +
    +
    +
    +

    Domain object containing details about the domain

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsDomain : Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Reverse Record +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Response object wrapper for querying a reverse record

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsDomainResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Response object wrapper for querying a reverse record in bulk

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsDomainBulkResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object containing an array of reverse records

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsReverseRecords : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Object containing all the info of the tezos domains record

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TezosDomainsReverseRecord : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + LiquidityBakingData + +
    +
    +
    +
    +
    +
    +

    Wrapper object to hold onto all the necessary data in order to work with liquidity baking contract (swap, add or remove liqudity)

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct LiquidityBakingData : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NFT + +
    +
    +
    +
    +
    +
    +

    An indiviual NFT (not the parent token/collection) holding a URI to an asset somewhere on the internet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct NFT : Codable, Hashable
    +
    extension NFT: Identifiable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NetworkConstants + +
    +
    +
    +
    +
    +
    +

    The contants that a given Tezos node is using for block times, blakc size etc

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct NetworkConstants : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NetworkVersion + +
    +
    +
    +
    +
    +
    +

    The version of the Tezos code being run by the given node

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct NetworkVersion : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NilOnDecodingError + +
    +
    +
    +
    +
    +
    +

    property wrapper to easily handle a situation where we don’t want decoding to fail for 1 property which may be problematic. Instead just default it to nil

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    @propertyWrapper
    +public struct NilOnDecodingError<Wrapped>
    +
    extension NilOnDecodingError: Decodable where Wrapped: Decodable
    +
    extension NilOnDecodingError: Encodable where Wrapped: Encodable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationBlockHeader + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationBlockHeader : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationFees + +
    +
    +
    +
    +
    +
    +

    A structure representing all the fees, storage and computation needed to perform an Operation

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationFees : Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationMetadata + +
    +
    +
    +
    +
    +
    +

    Structure representing the metadata needed by Operation‘s in order to comply with the RPC standards

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationMetadata : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationPayload + +
    +
    +
    +
    +
    +
    +

    A structure representing the request that needs to be made when sending Opertion‘s to the RPC

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationPayload : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationResponse + +
    +
    +
    +
    +
    +
    +

    Structure representing the response returned from RPC endpoints such as .../preapply/operations

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponse : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The main content of the JSON returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseContent : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The metadata belonging to the OperationResponse

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseMetadata : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + BalanceUpdate + +
    +
    +
    +
    +
    +
    +

    Struct representing a change to the balance of the sender, destination or intermediary contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct BalanceUpdate : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The inner result key from the OeprationResponse

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseResult : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Definition of the internal operation found inside OperationResponse

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseInternalOperation : Codable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Definition of the outer Error object found inside OperationResponseInternalResult

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationResponseInternalResultError : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + FailWith + +
    +
    +
    +
    +
    +
    +

    The error string, error int (code), or micheline error object returned inside FailWith

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct FailWith : Codable, Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + RunOperationPayload + +
    +
    +
    +
    +
    +
    +

    Payload object needed when sending operations to …/run_operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct RunOperationPayload : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SVGImgProcessor + +
    +
    +
    +
    +
    +
    +

    SVG image processor for Kingfisher library

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SVGImgProcessor : ImageProcessor
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OperationSubscription + +
    +
    +
    +
    +
    +
    +

    Object for sending a request through SignalR to listen to operations for a given account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OperationSubscription : Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + WalletMetadataList + +
    +
    +
    +
    +
    +
    +

    Container to store groups of WalletMetadata based on type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct WalletMetadataList : Codable, Hashable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + WalletMetadata + +
    +
    +
    +
    +
    +
    +

    Object to store UI related info about wallets, seperated from the wallet object itself to avoid issues merging together

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct WalletMetadata : Codable, Hashable
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A struct to hold all the necessary calculations for a dex trade

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DexSwapCalculationResult
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A struct to hold all the necessary calculations for adding liquidity to a dex contract

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DexAddCalculationResult
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    A struct to hold all the necessary calculations for removing liquidity from a dex contract

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DexRemoveCalculationResult
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + KukaiError + +
    +
    +
    +
    +
    +
    +

    A struct conforming to Error, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves. +Comes with helpers to extract meaning from RPC errors, optionally includes all the network data that caused the error for easier retrieval, and a fallback human readbale description to ensure something useful is always shown to the user.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct KukaiError : CustomStringConvertible, Error
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + DApp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct DApp
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + OfflineConstants + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct OfflineConstants
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + SubverifierWrapper + +
    +
    +
    +
    +
    +
    +

    SDK requires information about the verifer that can’t be stored inside the verifier, add a wrapper object to allow passing of all the data

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct SubverifierWrapper
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/Account.html b/docsets/.docset/Contents/Resources/Documents/Structs/Account.html new file mode 100644 index 00000000..c64a0ae8 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/Account.html @@ -0,0 +1,1066 @@ + + + + Account Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Account

+
+
+ +
public struct Account : Codable, Hashable
+
extension Account: Identifiable
+ +
+
+

Fetching all the account balances is a lengthy task, involving many requests and parsing different structures. +This struct abstract the developer away from knowing all these details, and instead allows developers to access wallets balances in a more normal approach

+ +
+
+
+
    +
  • +
    + + + + walletAddress + +
    +
    +
    +
    +
    +
    +

    The wallet address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let walletAddress: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtzBalance + +
    +
    +
    +
    +
    +
    +

    The XTZ balance of the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let xtzBalance: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokens + +
    +
    +
    +
    +
    +
    +

    All the wallets FA1.2, FA2 funginble tokens

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokens: [Token]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + nfts + +
    +
    +
    +
    +
    +
    +

    All the wallets NFT’s, grouped into parent FA2 objects so they can be displayed in groups or individaully

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let nfts: [Token]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + recentNFTs + +
    +
    +
    +
    +
    +
    +

    10 most recent NFTs to hit the wallet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var recentNFTs: [NFT]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + liquidityTokens + +
    +
    +
    +
    +
    +
    +

    All the wallets Defi, Liquidity Tokens

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let liquidityTokens: [DipDupPositionData]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    TzKT object containing baker details + status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegate: TzKTAccountDelegate?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegationLevel + +
    +
    +
    +
    +
    +
    +

    The block level that the delegate was set

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegationLevel: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(walletAddress:) + +
    +
    +
    +
    +
    +
    +

    Basic init to default properties to zero / empty, so that optionals can be avoided on a key model throughout an app

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(walletAddress: String)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Full init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(walletAddress: String, xtzBalance: XTZAmount, tokens: [Token], nfts: [Token], recentNFTs: [NFT], liquidityTokens: [DipDupPositionData], delegate: TzKTAccountDelegate?, delegationLevel: Decimal?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var id: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/AggregateRewardInformation.html b/docsets/.docset/Contents/Resources/Documents/Structs/AggregateRewardInformation.html new file mode 100644 index 00000000..22e23d72 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/AggregateRewardInformation.html @@ -0,0 +1,953 @@ + + + + AggregateRewardInformation Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

AggregateRewardInformation

+
+
+ +
public struct AggregateRewardInformation : Codable, Hashable, Equatable
+ +
+
+

Object ot abstract away a significatn amount of logic involved in computing estimated reward payments from a baker

+ +
+
+
+
    +
  • +
    + + + + previousReward + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let previousReward: RewardDetails?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let estimatedPreviousReward: RewardDetails?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + estimatedNextReward + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let estimatedNextReward: RewardDetails?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(previousReward: RewardDetails?, estimatedPreviousReward: RewardDetails?, estimatedNextReward: RewardDetails?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isOutOfDate() + +
    +
    +
    +
    +
    +
    +

    Creating this object involves many expensive requests, but produces a result that is valid for up to ~3 days. +This function can be used to determine if its ok to read a previous object from a cache, or if it needs to be refreshed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isOutOfDate() -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    When previousReward is present, it is possible that due to a delay in payment being received, that we may cache an object before the last payment was received +In this case, if we only relied on isOutOfDate() we would not update again for ~3 days. Both checks will be needed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func moreThan1CycleBetweenPreiousAndNext() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: AggregateRewardInformation, rhs: AggregateRewardInformation) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/BetterCallDevOperation.html b/docsets/.docset/Contents/Resources/Documents/Structs/BetterCallDevOperation.html new file mode 100644 index 00000000..ae2d8f98 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/BetterCallDevOperation.html @@ -0,0 +1,958 @@ + + + + BetterCallDevOperation Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevOperation

+
+
+ +
public struct BetterCallDevOperation : Codable
+ +
+
+

A model matching the response that comes back from BetterCallDev’s API: v1/opg/<operation-hash>

+ +
+
+
+
    +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    +

    An ID used by BCD

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    +

    The operation hash

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    +

    The operations numeric counter

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let counter: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    Indicating if the operation was successful, failed, backtracked etc.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let status: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    +

    Detailed error objects, also including unique smart contract errors

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errors: [BetterCallDevOperationError]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFailed() + +
    +
    +
    +
    +
    +
    +

    Helper to determine if the operation failed or not

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isFailed() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + containsError() + +
    +
    +
    +
    +
    +
    +

    Helper to check for existance of errors

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func containsError() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + moreDetailedError() + +
    +
    +
    +
    +
    +
    +

    When looking for more detailed errors through Better-Call.dev, effectively we are looking for an error containing a location and/or a with. +We already have the other bits, but only location and with can identify the specific Dexter error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func moreDetailedError() -> BetterCallDevOperationError?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/BetterCallDevOperationError.html b/docsets/.docset/Contents/Resources/Documents/Structs/BetterCallDevOperationError.html new file mode 100644 index 00000000..7ab093b3 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/BetterCallDevOperationError.html @@ -0,0 +1,897 @@ + + + + BetterCallDevOperationError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BetterCallDevOperationError

+
+
+ +
public struct BetterCallDevOperationError : Codable
+ +
+
+

BetterCallDev structure for errors

+ +
+
+
+
    +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + title + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let title: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + descr + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let descr: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + kind + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let kind: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + location + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let location: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + with + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let with: String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/BlockchainHead.html b/docsets/.docset/Contents/Resources/Documents/Structs/BlockchainHead.html new file mode 100644 index 00000000..8d977726 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/BlockchainHead.html @@ -0,0 +1,822 @@ + + + + BlockchainHead Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

BlockchainHead

+
+
+ +
public struct BlockchainHead : Codable
+ +
+
+

Structure representing the HEAD of the blockchain

+ +
+
+
+
    +
  • +
    + + + + protocol + +
    +
    +
    +
    +
    +
    +

    The current protocol version string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let `protocol`: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + chainID + +
    +
    +
    +
    +
    +
    +

    The current chainID being used

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let chainID: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    +

    The current hash or branch being used

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DexAddCalculationResult.html b/docsets/.docset/Contents/Resources/Documents/Structs/DexAddCalculationResult.html new file mode 100644 index 00000000..ef5854c8 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DexAddCalculationResult.html @@ -0,0 +1,871 @@ + + + + DexAddCalculationResult Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DexAddCalculationResult

+
+
+ +
public struct DexAddCalculationResult
+ +
+
+

A struct to hold all the necessary calculations for adding liquidity to a dex contract

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DexRemoveCalculationResult.html b/docsets/.docset/Contents/Resources/Documents/Structs/DexRemoveCalculationResult.html new file mode 100644 index 00000000..ff731814 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DexRemoveCalculationResult.html @@ -0,0 +1,897 @@ + + + + DexRemoveCalculationResult Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DexRemoveCalculationResult

+
+
+ +
public struct DexRemoveCalculationResult
+ +
+
+

A struct to hold all the necessary calculations for removing liquidity from a dex contract

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DexSwapCalculationResult.html b/docsets/.docset/Contents/Resources/Documents/Structs/DexSwapCalculationResult.html new file mode 100644 index 00000000..d0c4a55e --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DexSwapCalculationResult.html @@ -0,0 +1,871 @@ + + + + DexSwapCalculationResult Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DexSwapCalculationResult

+
+
+ +
public struct DexSwapCalculationResult
+ +
+
+

A struct to hold all the necessary calculations for a dex trade

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DipDupChartData.html b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupChartData.html new file mode 100644 index 00000000..449e416f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupChartData.html @@ -0,0 +1,849 @@ + + + + DipDupChartData Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupChartData

+
+
+ +
public struct DipDupChartData : Codable
+ +
+
+

Struct to hold 4 arrays of data, each one mapping to a different timeline of data, to allow the display of graphs

+ +
+
+
+
    +
  • +
    + + + + quotes15mNogaps + +
    +
    +
    +
    +
    +
    +

    Contains the last 24 hours of data at 15 min intervals

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let quotes15mNogaps: [DipDupChartObject]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + quotes1hNogaps + +
    +
    +
    +
    +
    +
    +

    Contains every hour for past 7 days

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let quotes1hNogaps: [DipDupChartObject]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + quotes1dNogaps + +
    +
    +
    +
    +
    +
    +

    Contains every day for 30 days

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let quotes1dNogaps: [DipDupChartObject]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + quotes1wNogaps + +
    +
    +
    +
    +
    +
    +

    Contains every week for 52 weeks

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let quotes1wNogaps: [DipDupChartObject]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DipDupChartObject.html b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupChartObject.html new file mode 100644 index 00000000..049a5542 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupChartObject.html @@ -0,0 +1,984 @@ + + + + DipDupChartObject Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupChartObject

+
+
+ +
public struct DipDupChartObject : Codable
+ +
+
+

Structure holding a data slice

+ +
+
+
+
    +
  • +
    + + + + average + +
    +
    +
    +
    +
    +
    +

    The average price at the given time

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let average: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchangeId + +
    +
    +
    +
    +
    +
    +

    The address of the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let exchangeId: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bucket + +
    +
    +
    +
    +
    +
    +

    String representing the date and time the slice is for

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bucket: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + high + +
    +
    +
    +
    +
    +
    +

    The highest value reached in this slice

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let high: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + low + +
    +
    +
    +
    +
    +
    +

    The lowest value reached in this slice

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let low: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + date() + +
    +
    +
    +
    +
    +
    +

    Convert the bucket string into a Date object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func date() -> Date?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + averageDouble() + +
    +
    +
    +
    +
    +
    +

    Convert the average value into a Double

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func averageDouble() -> Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + highDouble() + +
    +
    +
    +
    +
    +
    +

    Convert the high value into a Double

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func highDouble() -> Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lowDouble() + +
    +
    +
    +
    +
    +
    +

    Convert the low value into a Double

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func lowDouble() -> Double
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DipDupExchange.html b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupExchange.html new file mode 100644 index 00000000..026b397d --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupExchange.html @@ -0,0 +1,1132 @@ + + + + DipDupExchange Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupExchange

+
+
+ +
public struct DipDupExchange : Codable, Hashable, Equatable
+ +
+
+

A DipDup Exchange object with all the necessary pieces for checking liquidity and performing Swaps

+ +
+
+
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    Enum to denote the type of Exchange (e.g. Liquidity Baking, Quipuswap)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: DipDupExchangeName
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The KT address of the exchange contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tezPool + +
    +
    +
    +
    +
    +
    +

    String representation of the Exchanges TezPool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tezPool: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenPool + +
    +
    +
    +
    +
    +
    +

    String representation of the Exchanges TokenPool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenPool: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + sharesTotal + +
    +
    +
    +
    +
    +
    +

    The total liquidity available (RPC representation, no decimals)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let sharesTotal: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + midPrice + +
    +
    +
    +
    +
    +
    +

    The daily middle price

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let midPrice: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    The token object containing all the token info (decimals, contract address, symbol etc,)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token: DipDupToken
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Helper functions +

+
+
+
    +
  • +
    + + + + xtzPoolAmount() + +
    +
    +
    +
    +
    +
    +

    Return the XTZ pool as an XTZAmount object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzPoolAmount() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenPoolAmount() + +
    +
    +
    +
    +
    +
    +

    Return the Token pool as an TokenAmount object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenPoolAmount() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Retrieving the liquidity token decimals is currently not supported. Hardcode the numbers for now

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func liquidityTokenDecimalPlaces() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + totalLiquidity() + +
    +
    +
    +
    +
    +
    +

    Return the total liquidity as an TokenAmount object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func totalLiquidity() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + arePoolsEmpty() + +
    +
    +
    +
    +
    +
    +

    Helper to detect if the pools are empty (determiens if the next addLiquidity will be setting the exchange rate)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func arePoolsEmpty() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: DipDupExchange, rhs: DipDupExchange) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DipDupExchangesAndTokens.html b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupExchangesAndTokens.html new file mode 100644 index 00000000..a9c88e18 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupExchangesAndTokens.html @@ -0,0 +1,872 @@ + + + + DipDupExchangesAndTokens Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupExchangesAndTokens

+
+
+ +
public struct DipDupExchangesAndTokens : Codable
+ +
+
+

Wrapper object to map to network response type

+ +
+
+
+
    +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenId: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchanges + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let exchanges: [DipDupExchange]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get the total XTZ pool amount from all the exchanges, useful for sorting

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func totalExchangeXtzPool() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DipDupExchangesAndTokensResponse.html b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupExchangesAndTokensResponse.html new file mode 100644 index 00000000..1e24e9ca --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupExchangesAndTokensResponse.html @@ -0,0 +1,767 @@ + + + + DipDupExchangesAndTokensResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupExchangesAndTokensResponse

+
+
+ +
public struct DipDupExchangesAndTokensResponse : Codable
+ +
+
+

Wrapper object to map to network response type

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DipDupPosition.html b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupPosition.html new file mode 100644 index 00000000..2bdde5bb --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupPosition.html @@ -0,0 +1,767 @@ + + + + DipDupPosition Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupPosition

+
+
+ +
public struct DipDupPosition : Codable
+ +
+
+

Wrapper object to match network response type

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DipDupPositionData.html b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupPositionData.html new file mode 100644 index 00000000..f1cd6f0b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupPositionData.html @@ -0,0 +1,876 @@ + + + + DipDupPositionData Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupPositionData

+
+
+ +
public struct DipDupPositionData : Codable, Hashable, Equatable
+ +
+
+

A position on DipDup corresponds to liquidity token ownership. Each of these objects represents an amount of Liquidity tokens in an exchange for the given address

+ +
+
+
+
    +
  • +
    + + + + sharesQty + +
    +
    +
    +
    +
    +
    +

    The liquidity token balance (rpc representation)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let sharesQty: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchange + +
    +
    +
    +
    +
    +
    +

    The exchange the token belongs too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let exchange: DipDupExchange
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenAmount() + +
    +
    +
    +
    +
    +
    +

    Convert the token data into a TokenAmount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenAmount() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: DipDupPositionData, rhs: DipDupPositionData) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/DipDupToken.html b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupToken.html new file mode 100644 index 00000000..37ae82f0 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/DipDupToken.html @@ -0,0 +1,930 @@ + + + + DipDupToken Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

DipDupToken

+
+
+ +
public struct DipDupToken : Codable, Hashable, Equatable
+ +
+
+

DipDup representation of a Token

+ +
+
+
+
    +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    +

    The user facing symbol of the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The TZ address of the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    +

    The token ID of the token (always 0 for FA1.2 tokens)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenId: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimals + +
    +
    +
    +
    +
    +
    +

    The number of decimals for the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let decimals: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + standard + +
    +
    +
    +
    +
    +
    +

    Which standard the token follows

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let standard: DipDupTokenStandard
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable to enable working with UITableViewDiffableDataSource

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: DipDupToken, rhs: DipDupToken) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/FailWith.html b/docsets/.docset/Contents/Resources/Documents/Structs/FailWith.html new file mode 100644 index 00000000..732c2388 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/FailWith.html @@ -0,0 +1,871 @@ + + + + FailWith Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FailWith

+
+
+ +
public struct FailWith : Codable, Equatable
+ +
+
+

The error string, error int (code), or micheline error object returned inside FailWith

+ +
+
+
+
    +
  • +
    + + + + string + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let string: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + int + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let int: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + args + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let args: [[String : String]]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(string: String?, int: String?, args: [[String : String]]?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/FailWithParserLiquidityBaking.html b/docsets/.docset/Contents/Resources/Documents/Structs/FailWithParserLiquidityBaking.html new file mode 100644 index 00000000..b6f65b80 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/FailWithParserLiquidityBaking.html @@ -0,0 +1,767 @@ + + + + FailWithParserLiquidityBaking Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

FailWithParserLiquidityBaking

+
+
+ +
public struct FailWithParserLiquidityBaking : FailWithParser
+ +
+
+

Dedicated “FailWith” parser for the codes received from Liquidity Baking contract

+ +
+
+
+
    +
  • +
    + + + + parse(failWith:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parse(failWith: FailWith?) -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/GraphQLError.html b/docsets/.docset/Contents/Resources/Documents/Structs/GraphQLError.html new file mode 100644 index 00000000..7b39d499 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/GraphQLError.html @@ -0,0 +1,822 @@ + + + + GraphQLError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

GraphQLError

+
+
+ +
public struct GraphQLError : Codable
+ +
+
+

GraphQL error object

+ +
+
+
+
    +
  • +
    + + + + message + +
    +
    +
    +
    +
    +
    +

    Message sent from the server explaining the issue

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let message: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + locations + +
    +
    +
    +
    +
    +
    +

    Identifying the location fo the issue. E.g. codefile and line, or location of unexpected character/symbol in request string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let locations: [String : String]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + extenstions + +
    +
    +
    +
    +
    +
    +

    Not sure, but it shows up sometimes

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let extenstions: [String : String]?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/GraphQLResponse.html b/docsets/.docset/Contents/Resources/Documents/Structs/GraphQLResponse.html new file mode 100644 index 00000000..fff77186 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/GraphQLResponse.html @@ -0,0 +1,795 @@ + + + + GraphQLResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

GraphQLResponse

+
+
+ +
public struct GraphQLResponse<T> : Codable where T : Decodable, T : Encodable
+ +
+
+

Simple model object to wrap a GraphQL response to expose a Codable response without having to use large GraphQL libraries

+ +
+
+
+
    +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    +

    Array of errors returned from the server

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errors: [GraphQLError]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + data + +
    +
    +
    +
    +
    +
    +

    Generic data type matching the user supplied type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let data: T?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/KukaiError.html b/docsets/.docset/Contents/Resources/Documents/Structs/KukaiError.html new file mode 100644 index 00000000..c49e21f8 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/KukaiError.html @@ -0,0 +1,1347 @@ + + + + KukaiError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

KukaiError

+
+
+ +
public struct KukaiError : CustomStringConvertible, Error
+ +
+
+

A struct conforming to Error, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves. +Comes with helpers to extract meaning from RPC errors, optionally includes all the network data that caused the error for easier retrieval, and a fallback human readbale description to ensure something useful is always shown to the user.

+ +
+
+
+
    +
  • +
    + + + + ErrorType + +
    +
    +
    +
    +
    +
    +

    Categories of errors that are possible

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum ErrorType : Equatable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errorType + +
    +
    +
    +
    +
    +
    +

    The error category

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errorType: ErrorType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + knownErrorMessage + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let knownErrorMessage: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + subType + +
    +
    +
    +
    +
    +
    +

    Optional error subType coming from another source (the OS, URLSession, another library etc)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let subType: Error?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + rpcErrorString + +
    +
    +
    +
    +
    +
    +

    Optional string containing only the relvant portion of an RPC error (e.g instead of “proto.xxxxxxxx.gas_exhausted.operation”, it would contain “gas_exhausted.operation”) to make parsing easier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let rpcErrorString: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + failWith + +
    +
    +
    +
    +
    +
    +

    Optional object containing smart contract failure casues. May contain an Int (error code), a String (semi human readbale error message), and/or a dictionary containing metadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let failWith: FailWith?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + requestURL + +
    +
    +
    +
    +
    +
    +

    The requested URL that returned the error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var requestURL: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + requestJSON + +
    +
    +
    +
    +
    +
    +

    The JSON that was sent as part of the request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var requestJSON: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + responseJSON + +
    +
    +
    +
    +
    +
    +

    The raw JSON that was returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var responseJSON: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + httpStatusCode + +
    +
    +
    +
    +
    +
    +

    The HTTP status code returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var httpStatusCode: Int?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Constructors +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Create a KukaiError from an RPC string (will not be validated). You can use the string extension .removeLeadingProtocolFromRPCError() to strip the leading poriton of the error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func rpcError(rpcErrorString: String, andFailWith: FailWith?) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + systemError(subType:) + +
    +
    +
    +
    +
    +
    +

    Create a KukaiError denoting a sytem issue from the OS, by passing in the system Error type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func systemError(subType: Error) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a KukaiError denoting a network issue, by passing in the HTTP status code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func networkError(statusCode: Int, requestURL: URL) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a KukaiError denoting an issue from some other component or library, by passing in the error that piece of code returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func internalApplicationError(error: Error) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decodingError(error:) + +
    +
    +
    +
    +
    +
    +

    Create a KukaiError denoting an issue from some other component or library, by passing in the error that piece of code returned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func decodingError(error: Error) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + knownErrorMessage(_:) + +
    +
    +
    +
    +
    +
    +

    Create a KukaiError allowing a client to simply provide the required error message. +E.g. In situations where GraphQL returns a malformed object instead of an error, resulting in a decodingError, a client can catch that, supress it, and instead reutrn an error explaining that this record couldn’t be found

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func knownErrorMessage(_ message: String) -> KukaiError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown(withString:) + +
    +
    +
    +
    +
    +
    +

    Create an unknown KukaiError

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func unknown(withString: String? = nil) -> KukaiError
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Modifiers +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    For network errors, attach all the necessary network data that may be needed in order to debug the issue, or log to a tool such as sentry

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func addNetworkData(requestURL: URL?, requestJSON: Data?, responseJSON: Data?, httpStatusCode: Int?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Display +

+
+
+
    +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Prints the underlying error type with either an RPC string, or an underlying Error object contents

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func checkErrorForKnownCase(_ err: Error) -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func messageForNetworkStatusCode(statusCode: Int, url: URL) -> String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/KukaiError/ErrorType.html b/docsets/.docset/Contents/Resources/Documents/Structs/KukaiError/ErrorType.html new file mode 100644 index 00000000..2645435e --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/KukaiError/ErrorType.html @@ -0,0 +1,930 @@ + + + + ErrorType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ErrorType

+
+
+ +
public enum ErrorType : Equatable
+ +
+
+

Categories of errors that are possible

+ +
+
+
+
    +
  • +
    + + + + rpc + +
    +
    +
    +
    +
    +
    +

    RPC errors come directly from the Tezos RPC, but with the massive JSON object filtered down to the most meraningful part

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case rpc
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + system + +
    +
    +
    +
    +
    +
    +

    System errors are ones coming from the OS, e.g. “No internet connection”

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case system
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + network(_:) + +
    +
    +
    +
    +
    +
    +

    Network errors are returned by a server, such as HTTP 404’s and 500’s

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case network(Int)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + internalApplication + +
    +
    +
    +
    +
    +
    +

    Internal application errors are errors from other services, components, libraiers etc, wrapped up so that they don’t require extra parsing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case internalApplication
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decodingError + +
    +
    +
    +
    +
    +
    +

    For situations where the wrong model is returned. This can happen sometimes unexpectedily in GraphQL based APIs, instead of returning an error, it will just return a partial object missing non-optional fields

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case decodingError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + knownError + +
    +
    +
    +
    +
    +
    +

    For clients to catch known errors, sometimes handled in odd ways, enabling the easy return of a String. E.g. GraphQL throwing a malformed object response for a situation that should be a 404

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case knownError
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    +

    Used as a fallback for strange edge cases where we can’t easily idenitfiy the issue

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/LiquidityBakingData.html b/docsets/.docset/Contents/Resources/Documents/Structs/LiquidityBakingData.html new file mode 100644 index 00000000..3c26e415 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/LiquidityBakingData.html @@ -0,0 +1,876 @@ + + + + LiquidityBakingData Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LiquidityBakingData

+
+
+ +
public struct LiquidityBakingData : Codable
+ +
+
+

Wrapper object to hold onto all the necessary data in order to work with liquidity baking contract (swap, add or remove liqudity)

+ +
+
+
+
    +
  • +
    + + + + xtzPool + +
    +
    +
    +
    +
    +
    +

    The total amount of XTZ in the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let xtzPool: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenPool + +
    +
    +
    +
    +
    +
    +

    The total amount of the token in the contract (currently tzBTC)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenPool: TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + totalLiquidity + +
    +
    +
    +
    +
    +
    +

    The total amount of liquidity tokens in circulation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let totalLiquidity: TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenContractAddress + +
    +
    +
    +
    +
    +
    +

    The address of the dex contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenContractAddress: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The address of the liquidty token contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let liquidityTokenContractAddress: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/LoggingConfig.html b/docsets/.docset/Contents/Resources/Documents/Structs/LoggingConfig.html new file mode 100644 index 00000000..184f02a6 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/LoggingConfig.html @@ -0,0 +1,803 @@ + + + + LoggingConfig Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

LoggingConfig

+
+
+ +
public struct LoggingConfig
+ +
+
+

A struct to control what messages get logged

+ +
+
+
+
+ + +
+ +

Functions +

+
+
+
    +
  • +
    + + + + allOff() + +
    +
    +
    +
    +
    +
    +

    Turn off all logging

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func allOff()
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allOn() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func allOn()
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/NFT.html b/docsets/.docset/Contents/Resources/Documents/Structs/NFT.html new file mode 100644 index 00000000..8bb6c09e --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/NFT.html @@ -0,0 +1,1327 @@ + + + + NFT Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NFT

+
+
+ +
public struct NFT : Codable, Hashable
+
extension NFT: Identifiable
+ +
+
+

An indiviual NFT (not the parent token/collection) holding a URI to an asset somewhere on the internet

+ +
+
+
+
    +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    +

    Each NFT of a token has a unique ID

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenId: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + duplicateID + +
    +
    +
    +
    +
    +
    +

    In order to display in a tablview, the element must be hashable. But in cases where you want to show duplciates (e.g. recents), the computed hash needs to be slightly different +This property can be used as a quick hack a copy of the NFT struct slightly different, without affecting the data

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var duplicateID: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parentContract + +
    +
    +
    +
    +
    +
    +

    The address of the FA2 contract that created this NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parentContract: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parentAlias + +
    +
    +
    +
    +
    +
    +

    The human readable alias of the parent contract (e.g. “Mooncakes”)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parentAlias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + faVersion + +
    +
    +
    +
    +
    +
    +

    The FaVersion of the token contrac

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let faVersion: FaVersion
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimalPlaces + +
    +
    +
    +
    +
    +
    +

    Get the underlying number of decimal places that this token represents

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimalPlaces: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    Number of duplicate items of this NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    Human readbale name (e.g. “Tezos”)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    +

    Human readbale symbol (e.g. “XTZ”)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let symbol: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Human readable description (e.g. “This NFT was created too…”)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let description: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + artifactURI + +
    +
    +
    +
    +
    +
    +

    A URI to the asset the NFT is controlling ownership of

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let artifactURI: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + displayURI + +
    +
    +
    +
    +
    +
    +

    A URI used to display media of the artifact

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let displayURI: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + thumbnailURI + +
    +
    +
    +
    +
    +
    +

    A smaller thumbnail used to display meda of the artifact

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let thumbnailURI: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Metadata object containing useful information about the nft and its contents

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var metadata: TzKTBalanceMetadata?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isHidden + +
    +
    +
    +
    +
    +
    +

    Recording if the user has marked the token as hidden

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isHidden: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + favouriteSortIndex + +
    +
    +
    +
    +
    +
    +

    Recording if the position the index the user chose for the favourite token to appear

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var favouriteSortIndex: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFavourite + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var isFavourite: Bool { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create a more developer friednly NFT from a generic TzKTBalance object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(fromTzKTBalance tzkt: TzKTBalance)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + fromTzKTBalance + + +
    +

    An instance of TzKTBalance containing data about an NFT

    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Confomring to Equatable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: NFT, rhs: NFT) -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Hashable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var id: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/NetworkConstants.html b/docsets/.docset/Contents/Resources/Documents/Structs/NetworkConstants.html new file mode 100644 index 00000000..a0b738a1 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/NetworkConstants.html @@ -0,0 +1,1105 @@ + + + + NetworkConstants Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkConstants

+
+
+ +
public struct NetworkConstants : Codable
+ +
+
+

The contants that a given Tezos node is using for block times, blakc size etc

+ +
+
+
+
    +
  • +
    + + + + minimal_block_delay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let minimal_block_delay: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hard_gas_limit_per_operation: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hard_gas_limit_per_block: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + origination_size + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let origination_size: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + cost_per_byte + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cost_per_byte: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hard_storage_limit_per_operation: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func secondsBetweenBlocks() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mutezPerByte() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func mutezPerByte() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtzPerByte() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzPerByte() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + maxGasPerOperation() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func maxGasPerOperation() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + maxGasPerBlock() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func maxGasPerBlock() -> Int
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func maxStoragePerOperation() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bytesForReveal() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func bytesForReveal() -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtzForReveal() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func xtzForReveal() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/NetworkVersion.html b/docsets/.docset/Contents/Resources/Documents/Structs/NetworkVersion.html new file mode 100644 index 00000000..8791712a --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/NetworkVersion.html @@ -0,0 +1,819 @@ + + + + NetworkVersion Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkVersion

+
+
+ +
public struct NetworkVersion : Codable
+ +
+
+

The version of the Tezos code being run by the given node

+ +
+
+
+
    +
  • +
    + + + + chainName_mainnet + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let chainName_mainnet: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + chainName() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func chainName() -> String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isMainnet() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isMainnet() -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/NilOnDecodingError.html b/docsets/.docset/Contents/Resources/Documents/Structs/NilOnDecodingError.html new file mode 100644 index 00000000..dabd6b5f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/NilOnDecodingError.html @@ -0,0 +1,874 @@ + + + + NilOnDecodingError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NilOnDecodingError

+
+
+ +
@propertyWrapper
+public struct NilOnDecodingError<Wrapped>
+
extension NilOnDecodingError: Decodable where Wrapped: Decodable
+
extension NilOnDecodingError: Encodable where Wrapped: Encodable
+ +
+
+

property wrapper to easily handle a situation where we don’t want decoding to fail for 1 property which may be problematic. Instead just default it to nil

+ +
+
+
+
    +
  • +
    + + + + init(wrappedValue:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(wrappedValue: Wrapped?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + wrappedValue + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var wrappedValue: Wrapped?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Wrapped: Decodable +

+
+
+
    +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Available where Wrapped: Encodable +

+
+
+
    +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktAttribute.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktAttribute.html new file mode 100644 index 00000000..77d5c7be --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktAttribute.html @@ -0,0 +1,766 @@ + + + + ObjktAttribute Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktAttribute

+
+
+ +
public struct ObjktAttribute : Codable
+ +
+
+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktAttributeCounts.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktAttributeCounts.html new file mode 100644 index 00000000..3e964f98 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktAttributeCounts.html @@ -0,0 +1,766 @@ + + + + ObjktAttributeCounts Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktAttributeCounts

+
+
+ +
public struct ObjktAttributeCounts : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + editions + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let editions: Decimal
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktAttributeData.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktAttributeData.html new file mode 100644 index 00000000..1916bdc1 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktAttributeData.html @@ -0,0 +1,818 @@ + + + + ObjktAttributeData Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktAttributeData

+
+
+ +
public struct ObjktAttributeData : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + attribute_counts + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let attribute_counts: [ObjktAttributeCounts]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktCollection.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktCollection.html new file mode 100644 index 00000000..78e51283 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktCollection.html @@ -0,0 +1,1053 @@ + + + + ObjktCollection Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktCollection

+
+
+ +
public struct ObjktCollection : Codable
+ +
+
+

Single collection item

+ +
+
+
+
    +
  • +
    + + + + contract + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contract: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + logo + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let logo: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + floor_price + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let floor_price: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let twitter: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + website + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let website: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + owners + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let owners: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + editions + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let editions: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + creator + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let creator: ObjktCreator?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + websiteURL() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func websiteURL() -> URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitterURL() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func twitterURL() -> URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + floorPrice() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func floorPrice() -> XTZAmount?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktCollections.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktCollections.html new file mode 100644 index 00000000..0b4b94ce --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktCollections.html @@ -0,0 +1,767 @@ + + + + ObjktCollections Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktCollections

+
+
+ +
public struct ObjktCollections : Codable
+ +
+
+

GarpQL bulk response for a group of collections

+ +
+
+
+
    +
  • +
    + + + + fa + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fa: [ObjktCollection]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktCreator.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktCreator.html new file mode 100644 index 00000000..93c10c3b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktCreator.html @@ -0,0 +1,844 @@ + + + + ObjktCreator Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktCreator

+
+
+ +
public struct ObjktCreator : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + alias + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let alias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + webiste + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let webiste: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + twitter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let twitter: String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktEvent.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktEvent.html new file mode 100644 index 00000000..b6eb0900 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktEvent.html @@ -0,0 +1,767 @@ + + + + ObjktEvent Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktEvent

+
+
+ +
public struct ObjktEvent : Codable
+ +
+
+

Single event item

+ +
+
+
+
    +
  • +
    + + + + price_xtz + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let price_xtz: Decimal?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktFa.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktFa.html new file mode 100644 index 00000000..cd384e8e --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktFa.html @@ -0,0 +1,793 @@ + + + + ObjktFa Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktFa

+
+
+ +
public struct ObjktFa : Codable
+ +
+
+

Single FA item

+ +
+
+
+
    +
  • +
    + + + + editions + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let editions: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + floor_price + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let floor_price: Decimal?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktListing.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktListing.html new file mode 100644 index 00000000..35e11ad8 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktListing.html @@ -0,0 +1,792 @@ + + + + ObjktListing Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktListing

+
+
+ +
public struct ObjktListing : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + seller_address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let seller_address: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + price_xtz + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let price_xtz: Decimal?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktSale.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktSale.html new file mode 100644 index 00000000..a4dadba3 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktSale.html @@ -0,0 +1,792 @@ + + + + ObjktSale Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktSale

+
+
+ +
public struct ObjktSale : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + price_xtz + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let price_xtz: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktToken.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktToken.html new file mode 100644 index 00000000..2e859a4c --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktToken.html @@ -0,0 +1,923 @@ + + + + ObjktToken Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktToken

+
+
+ +
public struct ObjktToken : Codable
+ +
+
+

Single token item

+ +
+
+
+
    +
  • +
    + + + + highest_offer + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let highest_offer: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lowest_ask + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let lowest_ask: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let metadata: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + attributes + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let attributes: [ObjktAttribute]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + listing_sales + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let listing_sales: [ObjktSale]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + listings_active + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let listings_active: [ObjktListing]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/ObjktTokenReponse.html b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktTokenReponse.html new file mode 100644 index 00000000..1a6e6614 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/ObjktTokenReponse.html @@ -0,0 +1,923 @@ + + + + ObjktTokenReponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ObjktTokenReponse

+
+
+ +
public struct ObjktTokenReponse : Codable
+ +
+
+

GarpQL response for required data for a given token

+ +
+
+
+
    +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token: [ObjktToken]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + event + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let event: [ObjktEvent]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fa + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fa: [ObjktFa]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isOnSale() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isOnSale() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + onSalePrice() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func onSalePrice() -> XTZAmount?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lastSalePrice() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func lastSalePrice() -> XTZAmount?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + floorPrice() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func floorPrice() -> XTZAmount?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/OperationBlockHeader.html b/docsets/.docset/Contents/Resources/Documents/Structs/OperationBlockHeader.html new file mode 100644 index 00000000..bded7cda --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/OperationBlockHeader.html @@ -0,0 +1,1131 @@ + + + + OperationBlockHeader Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationBlockHeader

+
+
+ +
public struct OperationBlockHeader : Codable, Equatable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proto + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let proto: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + predecessor + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let predecessor: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: Date
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + validationPass + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let validationPass: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationsHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let operationsHash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fitness + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fitness: [String]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + context + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let context: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + priority + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let priority: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proofOfWorkNonce + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let proofOfWorkNonce: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + seedNonceHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let seedNonceHash: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + signature + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let signature: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(level: Int, proto: Int, predecessor: String, timestamp: Date, validationPass: Int, operationsHash: String, fitness: [String], context: String, priority: Int, proofOfWorkNonce: String, seedNonceHash: String?, signature: String)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + CodingKeys + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum CodingKeys : String, CodingKey
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/OperationBlockHeader/CodingKeys.html b/docsets/.docset/Contents/Resources/Documents/Structs/OperationBlockHeader/CodingKeys.html new file mode 100644 index 00000000..60b97b79 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/OperationBlockHeader/CodingKeys.html @@ -0,0 +1,1052 @@ + + + + CodingKeys Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

CodingKeys

+
+
+ +
public enum CodingKeys : String, CodingKey
+ +
+
+ +
+
+
+
    +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case level
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proto + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case proto
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + predecessor + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case predecessor
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case timestamp
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + validationPass + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case validationPass = "validation_pass"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + operationsHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case operationsHash = "operations_hash"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fitness + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case fitness
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + context + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case context
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + priority + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case priority
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + proofOfWorkNonce + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case proofOfWorkNonce = "proof_of_work_nonce"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + seedNonceHash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case seedNonceHash = "seed_nonce_hash"
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + signature + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case signature
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/OperationFees.html b/docsets/.docset/Contents/Resources/Documents/Structs/OperationFees.html new file mode 100644 index 00000000..6db0d482 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/OperationFees.html @@ -0,0 +1,1037 @@ + + + + OperationFees Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationFees

+
+
+ +
public struct OperationFees : Equatable
+ +
+
+

A structure representing all the fees, storage and computation needed to perform an Operation

+ +
+
+
+
    +
  • +
    + + + + NetworkFeeType + +
    +
    +
    +
    +
    +
    +

    Enum to differentiate different types of extra fees. Such as allocation fees when sending to a currently unrevealed account.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum NetworkFeeType : String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + transactionFee + +
    +
    +
    +
    +
    +
    +

    The transaction fee that the sender is willing to pay in order to perform the Operation. +Strictly speaking operations don’t have a fee, but a gas cost, and fees and offered by the user instead. +Practically, bakers will prioritsie Operation‘s with higher fees. Resulting in default feePerGas rate being required in order to get a transaction through.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var transactionFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkFees + +
    +
    +
    +
    +
    +
    +

    Additional fees the account will have to pay in order to send this operation. Such as allocating space for an unrevealed account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var networkFees: [NetworkFeeType : XTZAmount]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + gasLimit + +
    +
    +
    +
    +
    +
    +

    The limit of gas (computation + CPU) this Operation should take. If it exceeds this value when running, the Operation will fail.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var gasLimit: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + storageLimit + +
    +
    +
    +
    +
    +
    +

    The limit of storage (disk) this Operation requires to complete. If it exceeds this value when running, the Operation will fail.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var storageLimit: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allFees() + +
    +
    +
    +
    +
    +
    +

    Add together all the network fees and transaction fees

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func allFees() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allNetworkFees() + +
    +
    +
    +
    +
    +
    +

    Add together all the network fees and transaction fees

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func allNetworkFees() -> XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + zero() + +
    +
    +
    +
    +
    +
    +

    Creates an OperationFees object, with everything set to zero. Primarly used as a default / placeholder until an estimation can be performed

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func zero() -> OperationFees
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Get a default fees for each type of Operation. No guarentee these will succeed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func defaultFees(operationKind: OperationKind) -> OperationFees
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + operationKind + + +
    +

    enum to denote the type of Operation

    +
    +
    +
    +
    +

    Return Value

    +

    a OperationFees object with all the values set.

    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Confirming to Equatable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: OperationFees, rhs: OperationFees) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/OperationFees/NetworkFeeType.html b/docsets/.docset/Contents/Resources/Documents/Structs/OperationFees/NetworkFeeType.html new file mode 100644 index 00000000..2e6ae629 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/OperationFees/NetworkFeeType.html @@ -0,0 +1,793 @@ + + + + NetworkFeeType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkFeeType

+
+
+ +
public enum NetworkFeeType : String
+ +
+
+

Enum to differentiate different types of extra fees. Such as allocation fees when sending to a currently unrevealed account.

+ +
+
+
+
    +
  • +
    + + + + burnFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case burnFee
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allocationFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case allocationFee
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/OperationMetadata.html b/docsets/.docset/Contents/Resources/Documents/Structs/OperationMetadata.html new file mode 100644 index 00000000..abbc4167 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/OperationMetadata.html @@ -0,0 +1,946 @@ + + + + OperationMetadata Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationMetadata

+
+
+ +
public struct OperationMetadata : Codable
+ +
+
+

Structure representing the metadata needed by Operation‘s in order to comply with the RPC standards

+ +
+
+
+
    +
  • +
    + + + + managerKey + +
    +
    +
    +
    +
    +
    +

    The public key of the account managing the sender of this Operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let managerKey: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    +

    The current counter used by this account on the network. All future Operation‘s need to be 1 higher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let counter: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + chainID + +
    +
    +
    +
    +
    +
    +

    The current Tezos network chainID to use for Operation‘s

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let chainID: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + branch + +
    +
    +
    +
    +
    +
    +

    The current branch used by the head block, used for estiamting and running preapply, to ensure the latest state information is available

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let branch: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + protocol + +
    +
    +
    +
    +
    +
    +

    The current Tezos network protocol to use for Operation‘s

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let `protocol`: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an OperationMetadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(managerKey: String?, counter: Int, blockchainHead: BlockchainHead)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + managerKey + + +
    +

    The public key of the account managing the sender of this Operation

    +
    +
    + + counter + + +
    +

    The current counter used by this account on the network. All future Operation‘s need to be 1 higher

    +
    +
    + + blockchainHead + + +
    +

    Decoded response of the blockchainHead, containing only the pieces we need

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/OperationPayload.html b/docsets/.docset/Contents/Resources/Documents/Structs/OperationPayload.html new file mode 100644 index 00000000..5b3b244a --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/OperationPayload.html @@ -0,0 +1,918 @@ + + + + OperationPayload Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationPayload

+
+
+ +
public struct OperationPayload : Codable, Equatable
+ +
+
+

A structure representing the request that needs to be made when sending Opertion‘s to the RPC

+ +
+
+
+
    +
  • +
    + + + + branch + +
    +
    +
    +
    +
    +
    +

    The bracnh to use when sending

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var branch: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + contents + +
    +
    +
    +
    +
    +
    +

    An array of Operation‘s to be sent together in 1 request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var contents: [Operation]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    +

    Conforming to Equatable

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: OperationPayload, rhs: OperationPayload) -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Add the signature and the protocol to the operation so that it can be injected to the blockchain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func addSignature(_ binarySignature: [UInt8], signingCurve: EllipticalCurve)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + binarySignature + + +
    +

    Use the Wallet.sign(...) function to sign the forged version of the operationPayload.

    +
    +
    + + signingCurve + + +
    +

    The EllipticalCurve used for signing.

    +
    +
    + + andProtocol + + +
    +

    An OperationMetadata containing the network protocol to use to perform the injection.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func addProtcol(fromMetadata metadata: OperationMetadata)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/OperationResponse.html b/docsets/.docset/Contents/Resources/Documents/Structs/OperationResponse.html new file mode 100644 index 00000000..09b22fb8 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/OperationResponse.html @@ -0,0 +1,821 @@ + + + + OperationResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationResponse

+
+
+ +
public struct OperationResponse : Codable
+ +
+
+

Structure representing the response returned from RPC endpoints such as .../preapply/operations

+ +
+
+
+
    +
  • +
    + + + + contents + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contents: [OperationResponseContent]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFailed() + +
    +
    +
    +
    +
    +
    +

    Check if the operation(s) have been backtracked or reversed due to a failure

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isFailed() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors() + +
    +
    +
    +
    +
    +
    +

    Return the last error object from each internal result. The last error object is the one that contains the location of the error in the smart contract and the with string, giving the most debugable information

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func errors() -> [OperationResponseInternalResultError]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/OperationResponseInternalResultError.html b/docsets/.docset/Contents/Resources/Documents/Structs/OperationResponseInternalResultError.html new file mode 100644 index 00000000..c51603ee --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/OperationResponseInternalResultError.html @@ -0,0 +1,923 @@ + + + + OperationResponseInternalResultError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

OperationResponseInternalResultError

+
+
+ +
public struct OperationResponseInternalResultError : Codable, Equatable
+ +
+
+

Definition of the outer Error object found inside OperationResponseInternalResult

+ +
+
+
+
    +
  • +
    + + + + kind + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let kind: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + contract + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contract: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + expected + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let expected: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + found + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let found: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + location + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let location: Int?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + with + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let with: FailWith?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeLedger.html b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeLedger.html new file mode 100644 index 00000000..66267c7f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeLedger.html @@ -0,0 +1,795 @@ + + + + QuipuswapExchangeLedger Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeLedger

+
+
+ +
public struct QuipuswapExchangeLedger : Codable
+ +
+
+

The unique data inside the Ledger BigMap

+ +
+
+
+
    +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    Usable balance of the token owned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + frozen_balance + +
    +
    +
    +
    +
    +
    +

    Currently unaccessible balance of the token owned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let frozen_balance: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeLedgerKey.html b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeLedgerKey.html new file mode 100644 index 00000000..b6286395 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeLedgerKey.html @@ -0,0 +1,767 @@ + + + + QuipuswapExchangeLedgerKey Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeLedgerKey

+
+
+ +
public struct QuipuswapExchangeLedgerKey : Codable
+ +
+
+

The gneric container object holding the raw data

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeStorage.html b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeStorage.html new file mode 100644 index 00000000..403f1d77 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeStorage.html @@ -0,0 +1,1038 @@ + + + + QuipuswapExchangeStorage Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeStorage

+
+
+ +
public struct QuipuswapExchangeStorage : Codable
+ +
+
+

Unique Quipuswap contract storage object

+ +
+
+
+
    +
  • +
    + + + + ledger + +
    +
    +
    +
    +
    +
    +

    Ledger bigmap id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let ledger: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + user_rewards + +
    +
    +
    +
    +
    +
    +

    user rewards bigmap id

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let user_rewards: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward + +
    +
    +
    +
    +
    +
    +

    The current reward

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward_paid + +
    +
    +
    +
    +
    +
    +

    The amount of rewards paid out

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward_paid: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + total_reward + +
    +
    +
    +
    +
    +
    +

    Total reward

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let total_reward: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + total_supply + +
    +
    +
    +
    +
    +
    +

    Totoal supply of this token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let total_supply: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + period_finish + +
    +
    +
    +
    +
    +
    +

    Date/Time the period will finish

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let period_finish: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward_per_sec + +
    +
    +
    +
    +
    +
    +

    The reward per second

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward_per_sec: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + last_update_time + +
    +
    +
    +
    +
    +
    +

    Date/Time of the last recorded update to the sotrage

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let last_update_time: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward_per_share + +
    +
    +
    +
    +
    +
    +

    The entitled reward per 1 share owned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward_per_share: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + date(from:) + +
    +
    +
    +
    +
    +
    +

    Convert a string to a Date object using Zulu time format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func date(from: String) -> Date?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeStorageResponse.html b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeStorageResponse.html new file mode 100644 index 00000000..4f114204 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeStorageResponse.html @@ -0,0 +1,767 @@ + + + + QuipuswapExchangeStorageResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeStorageResponse

+
+
+ +
public struct QuipuswapExchangeStorageResponse : Codable
+ +
+
+

Network wrapper object

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeUserRewards.html b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeUserRewards.html new file mode 100644 index 00000000..6add71d5 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeUserRewards.html @@ -0,0 +1,795 @@ + + + + QuipuswapExchangeUserRewards Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeUserRewards

+
+
+ +
public struct QuipuswapExchangeUserRewards : Codable
+ +
+
+

The unique data inside the User Rewards BigMap

+ +
+
+
+
    +
  • +
    + + + + reward + +
    +
    +
    +
    +
    +
    +

    Total reward the user has earned

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reward_paid + +
    +
    +
    +
    +
    +
    +

    Total rewards that have been paid out to the user

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reward_paid: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeUserRewardsKey.html b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeUserRewardsKey.html new file mode 100644 index 00000000..a044394b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/QuipuswapExchangeUserRewardsKey.html @@ -0,0 +1,767 @@ + + + + QuipuswapExchangeUserRewardsKey Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

QuipuswapExchangeUserRewardsKey

+
+
+ +
public struct QuipuswapExchangeUserRewardsKey : Codable
+ +
+
+

The gneric container object holding the raw data

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/RewardDetails.html b/docsets/.docset/Contents/Resources/Documents/Structs/RewardDetails.html new file mode 100644 index 00000000..30f86a91 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/RewardDetails.html @@ -0,0 +1,975 @@ + + + + RewardDetails Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

RewardDetails

+
+
+ +
public struct RewardDetails : Codable
+ +
+
+

An individual payment record denoting some payment in the past or future

+ +
+
+
+
    +
  • +
    + + + + bakerAlias + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bakerAlias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bakerLogo + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let bakerLogo: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + paymentAddress + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let paymentAddress: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let amount: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + cycle + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cycle: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fee: Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + dateOfPayment + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let dateOfPayment: Date
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + meetsMinDelegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let meetsMinDelegation: Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(bakerAlias: String?, bakerLogo: URL?, paymentAddress: String, amount: XTZAmount, cycle: Int, fee: Double, date: Date, meetsMinDelegation: Bool)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/SVGImgProcessor.html b/docsets/.docset/Contents/Resources/Documents/Structs/SVGImgProcessor.html new file mode 100644 index 00000000..a19a7f71 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/SVGImgProcessor.html @@ -0,0 +1,793 @@ + + + + SVGImgProcessor Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

SVGImgProcessor

+
+
+ +
public struct SVGImgProcessor : ImageProcessor
+ +
+
+

SVG image processor for Kingfisher library

+ +
+
+
+
    +
  • +
    + + + + identifier + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var identifier: String
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/SubverifierWrapper.html b/docsets/.docset/Contents/Resources/Documents/Structs/SubverifierWrapper.html new file mode 100644 index 00000000..696c9bf9 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/SubverifierWrapper.html @@ -0,0 +1,849 @@ + + + + SubverifierWrapper Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

SubverifierWrapper

+
+
+ +
public struct SubverifierWrapper
+ +
+
+

SDK requires information about the verifer that can’t be stored inside the verifier, add a wrapper object to allow passing of all the data

+ +
+
+
+
    +
  • +
    + + + + aggregateVerifierName + +
    +
    +
    +
    +
    +
    +

    The name of the aggregated verifier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let aggregateVerifierName: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkType + +
    +
    +
    +
    +
    +
    +

    Unlike seed based wallets, Torus verifiers are bound to a network and generate different addresses. In order to give the same experience on Tezos, we need to supply the network for each verifier

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let networkType: TezosNodeClientConfig.NetworkType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + subverifier + +
    +
    +
    +
    +
    +
    +

    The matching SubVerifierDetails object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let subverifier: SubVerifierDetails
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Create an instance of the object with an option string for the aggregate verifier name, and a SubVerifierDetails object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(aggregateVerifierName: String?, networkType: TezosNodeClientConfig.NetworkType, subverifier: SubVerifierDetails)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsAddressBulkResponse.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsAddressBulkResponse.html new file mode 100644 index 00000000..e1323998 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsAddressBulkResponse.html @@ -0,0 +1,795 @@ + + + + TezosDomainsAddressBulkResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsAddressBulkResponse

+
+
+ +
public struct TezosDomainsAddressBulkResponse : Codable
+ +
+
+

Response object wrapper for querying an address in bulk

+ +
+
+
+
    +
  • +
    + + + + domains + +
    +
    +
    +
    +
    +
    +

    Object containing all the info of the record

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let domains: TezosDomainsDomains?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(domains:) + +
    +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(domains: TezosDomainsDomains?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsAddressResponse.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsAddressResponse.html new file mode 100644 index 00000000..0dbb4903 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsAddressResponse.html @@ -0,0 +1,795 @@ + + + + TezosDomainsAddressResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsAddressResponse

+
+
+ +
public struct TezosDomainsAddressResponse : Codable
+ +
+
+

Response object wrapper for querying an address

+ +
+
+
+
    +
  • +
    + + + + domain + +
    +
    +
    +
    +
    +
    +

    Domain object containing details about the domain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let domain: TezosDomainsDomain
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(domain:) + +
    +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(domain: TezosDomainsDomain)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomain.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomain.html new file mode 100644 index 00000000..c9a03419 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomain.html @@ -0,0 +1,822 @@ + + + + TezosDomainsDomain Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsDomain

+
+
+ +
public struct TezosDomainsDomain : Codable
+ +
+
+

Domain object containing details about the domain

+ +
+
+
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    The domain name e.g. example.tez

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The Tezos address that the domain points too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(name:address:) + +
    +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(name: String, address: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomainBulkResponse.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomainBulkResponse.html new file mode 100644 index 00000000..ccf56c51 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomainBulkResponse.html @@ -0,0 +1,795 @@ + + + + TezosDomainsDomainBulkResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsDomainBulkResponse

+
+
+ +
public struct TezosDomainsDomainBulkResponse : Codable
+ +
+
+

Response object wrapper for querying a reverse record in bulk

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomainResponse.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomainResponse.html new file mode 100644 index 00000000..29258524 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomainResponse.html @@ -0,0 +1,822 @@ + + + + TezosDomainsDomainResponse Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsDomainResponse

+
+
+ +
public struct TezosDomainsDomainResponse : Codable
+ +
+
+

Response object wrapper for querying a reverse record

+ +
+
+
+
    +
  • +
    + + + + reverseRecord + +
    +
    +
    +
    +
    +
    +

    Object containing all the info of the record

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let reverseRecord: TezosDomainsReverseRecord?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + domain() + +
    +
    +
    +
    +
    +
    +

    Helper to extract the domain name more easily

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func domain() -> String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(reverseRecord:) + +
    +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(reverseRecord: TezosDomainsReverseRecord?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomains.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomains.html new file mode 100644 index 00000000..43a31d81 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsDomains.html @@ -0,0 +1,768 @@ + + + + TezosDomainsDomains Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsDomains

+
+
+ +
public struct TezosDomainsDomains : Codable
+ +
+
+

Object containing an array of domains

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsReverseRecord.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsReverseRecord.html new file mode 100644 index 00000000..b45d885d --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsReverseRecord.html @@ -0,0 +1,903 @@ + + + + TezosDomainsReverseRecord Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsReverseRecord

+
+
+ +
public struct TezosDomainsReverseRecord : Codable
+ +
+
+

Object containing all the info of the tezos domains record

+ +
+
+
+
    +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    +

    Uniquie id of the domain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The address that the domain points too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + owner + +
    +
    +
    +
    +
    +
    +

    The address that owns the domain

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let owner: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + expiresAtUtc + +
    +
    +
    +
    +
    +
    +

    Expiration date

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let expiresAtUtc: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + domain + +
    +
    +
    +
    +
    +
    +

    The domain object continaing the name and address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let domain: TezosDomainsDomain
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Default init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(id: String, address: String, owner: String, expiresAtUtc: String?, domain: TezosDomainsDomain)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsReverseRecords.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsReverseRecords.html new file mode 100644 index 00000000..49c07ae0 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosDomainsReverseRecords.html @@ -0,0 +1,768 @@ + + + + TezosDomainsReverseRecords Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosDomainsReverseRecords

+
+
+ +
public struct TezosDomainsReverseRecords : Codable
+ +
+
+

Object containing an array of reverse records

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig.html new file mode 100644 index 00000000..423d6323 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig.html @@ -0,0 +1,1417 @@ + + + + TezosNodeClientConfig Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TezosNodeClientConfig

+
+
+ +
public struct TezosNodeClientConfig
+ +
+
+

A configuration object used to provide settings to the TezosNodeClient

+ +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + NetworkType + +
    +
    +
    +
    +
    +
    +

    An enum indicating whether the network is mainnet or testnet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum NetworkType : String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ForgingType + +
    +
    +
    +
    +
    +
    +

    Allow switching between local forging or remote forging+parsing

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum ForgingType : String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Constants +

+
+
+
    +
  • +
    + + + + defaultMainnetURLs + +
    +
    +
    +
    +
    +
    +

    Preconfigured struct with all the URL’s needed to work with Tezos mainnet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct defaultMainnetURLs
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + defaultTestnetURLs + +
    +
    +
    +
    +
    +
    +

    Preconfigured struct with all the URL’s needed to work with Tezos testnet

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct defaultTestnetURLs
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + primaryNodeURL + +
    +
    +
    +
    +
    +
    +

    The main URL used for remote forging, fetching balances, setting delegates and other forms of queries and operations.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let primaryNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseNodeURL + +
    +
    +
    +
    +
    +
    +

    When using remote forging, it is essential to use a second server to verify the contents of the remote forge match what the library sent.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parseNodeURL: URL?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + forgingType + +
    +
    +
    +
    +
    +
    +

    Controls whether to use local forging or remote forging+parsing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let forgingType: ForgingType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzktURL + +
    +
    +
    +
    +
    +
    +

    The URL to use for TzKTClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tzktURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + betterCallDevURL + +
    +
    +
    +
    +
    +
    +

    The URL to use for BetterCallDevClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let betterCallDevURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tezosDomainsURL + +
    +
    +
    +
    +
    +
    +

    The URL to use for TezosDomainsClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tezosDomainsURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + objktApiURL + +
    +
    +
    +
    +
    +
    +

    The URL to use for TezosDomainsClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let objktApiURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + urlSession + +
    +
    +
    +
    +
    +
    +

    The URLSession that will be used for all network communication. If looking to mock this library, users should create their own URLSessionMock and pass it in.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var urlSession: URLSession
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + networkType + +
    +
    +
    +
    +
    +
    +

    The network type of the connected node

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let networkType: NetworkType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + loggingConfig + +
    +
    +
    +
    +
    +
    +

    Control what gets logged to the console

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var loggingConfig: LoggingConfig
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Init +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Init a TezosNodeClientConfig with the defaults

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(withDefaultsForNetworkType networkType: NetworkType)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + withDefaultsForNetworkType + + +
    +

    Use the default settings for the given network type

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an instance of TezosNodeClientConfig with only the required properties needed when using local forge.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func configWithLocalForge(primaryNodeURL: URL, tzktURL: URL, betterCallDevURL: URL, tezosDomainsURL: URL, objktApiURL: URL, urlSession: URLSession, networkType: NetworkType) -> TezosNodeClientConfig
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    + + primaryNodeURL + + +
    +

    The URL of the primary node that will perform the majority of the network operations.

    +
    +
    + + tzktURL + + +
    +

    The URL to use for TzKTClient.

    +
    +
    + + betterCallDevURL + + +
    +

    The URL to use for BetterCallDevClient.

    +
    +
    + + urlSession + + +
    +

    The URLSession object that will perform all the network operations.

    +
    +
    + + networkType + + +
    +

    Enum indicating the network type.

    +
    +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Creates an instance of TezosNodeClientConfig with the required properties for remote forging. Note: function will casue a fatalError is users attempt to set primaryNodeURL and parseNodeURL to the same destination

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func configWithRemoteForge(primaryNodeURL: URL, parseNodeURL: URL, tzktURL: URL, betterCallDevURL: URL, tezosDomainsURL: URL, objktApiURL: URL, urlSession: URLSession, networkType: NetworkType) -> TezosNodeClientConfig
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + primaryNodeURL + + +
    +

    The URL of the primary node that will perform the majority of the network operations.

    +
    +
    + + parseNodeURL + + +
    +

    The URL to use to parse and verify a remote forge. Must be a different server to primary node.

    +
    +
    + + tzktURL + + +
    +

    The URL to use for TzKTClient.

    +
    +
    + + betterCallDevURL + + +
    +

    The URL to use for BetterCallDevClient.

    +
    +
    + + urlSession + + +
    +

    The URLSession object that will perform all the network operations.

    +
    +
    + + networkType + + +
    +

    Enum indicating the network type.

    +
    +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/ForgingType.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/ForgingType.html new file mode 100644 index 00000000..9fce5776 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/ForgingType.html @@ -0,0 +1,793 @@ + + + + ForgingType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

ForgingType

+
+
+ +
public enum ForgingType : String
+ +
+
+

Allow switching between local forging or remote forging+parsing

+ +
+
+
+
    +
  • +
    + + + + local + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case local
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + remote + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case remote
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/NetworkType.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/NetworkType.html new file mode 100644 index 00000000..cd6cbb38 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/NetworkType.html @@ -0,0 +1,793 @@ + + + + NetworkType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

NetworkType

+
+
+ +
public enum NetworkType : String
+ +
+
+

An enum indicating whether the network is mainnet or testnet

+ +
+
+
+
    +
  • +
    + + + + mainnet + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case mainnet
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + testnet + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case testnet
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/defaultMainnetURLs.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/defaultMainnetURLs.html new file mode 100644 index 00000000..341c9610 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/defaultMainnetURLs.html @@ -0,0 +1,903 @@ + + + + defaultMainnetURLs Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

defaultMainnetURLs

+
+
+ +
public struct defaultMainnetURLs
+ +
+
+

Preconfigured struct with all the URL’s needed to work with Tezos mainnet

+ +
+
+
+
    +
  • +
    + + + + primaryNodeURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for primaryNodeURL, For more information on the free service, see: https://tezos.giganode.io/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let primaryNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseNodeURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for parseNodeURL, For more information on the free service, see: https://nautilus.cloud/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let parseNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzktURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tzktURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + betterCallDevURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let betterCallDevURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tezosDomainsURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tezosDomainsURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + objktApiURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let objktApiURL: URL
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/defaultTestnetURLs.html b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/defaultTestnetURLs.html new file mode 100644 index 00000000..1617410b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TezosNodeClientConfig/defaultTestnetURLs.html @@ -0,0 +1,904 @@ + + + + defaultTestnetURLs Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

defaultTestnetURLs

+
+
+ +
public struct defaultTestnetURLs
+ +
+
+

Preconfigured struct with all the URL’s needed to work with Tezos testnet

+ +
+
+
+
    +
  • +
    + + + + primaryNodeURL + +
    +
    +
    +
    +
    +
    +

    The default mainnet URL to use for primaryNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let primaryNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parseNodeURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for parseNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about +When using remote forging on mainnet, you should use two seperate servers on seperate networks for security reasons

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let parseNodeURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzktURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tzktURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + betterCallDevURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let betterCallDevURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tezosDomainsURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let tezosDomainsURL: URL
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + objktApiURL + +
    +
    +
    +
    +
    +
    +

    The default testnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let objktApiURL: URL
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTAccount.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTAccount.html new file mode 100644 index 00000000..aa817f84 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTAccount.html @@ -0,0 +1,1036 @@ + + + + TzKTAccount Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTAccount

+
+
+ +
public struct TzKTAccount : Codable, Equatable
+ +
+
+

Model mapping to TzKT.io’s Account object

+ +
+
+
+
    +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    The address XTZ balance in RPC format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    type of account e.g. “user” or “empty”

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    tz1/2/3 kt1 address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + publicKey + +
    +
    +
    +
    +
    +
    +

    prefixed public key

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let publicKey: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + revealed + +
    +
    +
    +
    +
    +
    +

    whether or not the account has performed a reveal operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let revealed: Bool?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    The addresses delegation status

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegate: TzKTAccountDelegate?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegationLevel + +
    +
    +
    +
    +
    +
    +

    The block level the delegate address was set

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let delegationLevel: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + activeTokensCount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let activeTokensCount: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenBalancesCount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenBalancesCount: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + xtzBalance + +
    +
    +
    +
    +
    +
    +

    Helper method to convert the RPC balance into an XTZAmount

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var xtzBalance: XTZAmount { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Generic init

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(balance: Decimal?, type: String, address: String, publicKey: String, revealed: Bool, delegate: TzKTAccountDelegate?, delegationLevel: Decimal?, activeTokensCount: Decimal?, tokenBalancesCount: Decimal?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTAccountDelegate.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTAccountDelegate.html new file mode 100644 index 00000000..7e1273fe --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTAccountDelegate.html @@ -0,0 +1,848 @@ + + + + TzKTAccountDelegate Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTAccountDelegate

+
+
+ +
public struct TzKTAccountDelegate : Codable, Equatable
+ +
+
+

Model mapping to TzKT.io’s Account.Delegate Object

+ +
+
+
+
    +
  • +
    + + + + alias + +
    +
    +
    +
    +
    +
    +

    Bakers may have an alias (human readbale) name for their service

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let alias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    Bakers must have a valid address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + active + +
    +
    +
    +
    +
    +
    +

    Bool indicating whether or not the baker is currently active

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let active: Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(alias: String?, address: String, active: Bool)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTAddress.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTAddress.html new file mode 100644 index 00000000..157568d1 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTAddress.html @@ -0,0 +1,821 @@ + + + + TzKTAddress Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTAddress

+
+
+ +
public struct TzKTAddress : Codable
+ +
+
+

Details about a given contract

+ +
+
+
+
    +
  • +
    + + + + alias + +
    +
    +
    +
    +
    +
    +

    Contract addresses may have an alias (human readbale) name, to denote a person or service

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let alias: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The KT1 address of the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(alias:address:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(alias: String?, address: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBaker.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBaker.html new file mode 100644 index 00000000..f25313c5 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBaker.html @@ -0,0 +1,1369 @@ + + + + TzKTBaker Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBaker

+
+
+ +
public struct TzKTBaker : Codable, Hashable
+ +
+
+

Data representing a baker from TzKT or Baking-Bad

+ +
+
+
+
    +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + logo + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let logo: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + stakingBalance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let stakingBalance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + stakingCapacity + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let stakingCapacity: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + maxStakingBalance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let maxStakingBalance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + freeSpace + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let freeSpace: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fee: Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + minDelegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let minDelegation: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutDelay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutDelay: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutPeriod + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutPeriod: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + openForDelegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let openForDelegation: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + estimatedRoi + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let estimatedRoi: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + serviceHealth + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let serviceHealth: TzKTBakerHealth
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutTiming + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutTiming: TzKTBakerTiming
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutAccuracy + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutAccuracy: TzKTBakerAccuracy
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + config + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let config: TzKTBakerConfig?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Helper to create a TzKTBaker from the data available from the Account object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(address: String, name: String?, logo: String?)
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(address: String, name: String?, logo: String?, balance: Decimal, stakingBalance: Decimal, stakingCapacity: Decimal, maxStakingBalance: Decimal, freeSpace: Decimal, fee: Double, minDelegation: Decimal, payoutDelay: Int, payoutPeriod: Int, openForDelegation: Bool, estimatedRoi: Decimal, serviceHealth: TzKTBakerHealth, payoutTiming: TzKTBakerTiming, payoutAccuracy: TzKTBakerAccuracy, config: TzKTBakerConfig?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fromTestnetArray(_:) + +
    +
    +
    +
    +
    +
    +

    Ghostnet has a different setup for bakers, but we need to display and interact with them the same way. +So this helper extract what it can from the API and creates semi-real baker objects to help users deal with Ghostnet

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func fromTestnetArray(_ data: [Any]) -> TzKTBaker?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + rewardStruct() + +
    +
    +
    +
    +
    +
    +

    Convert con-chain data into a meaningful, readable object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func rewardStruct() -> TzKTBakerConfigRewardStruct?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: TzKTBaker, rhs: TzKTBaker) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfig.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfig.html new file mode 100644 index 00000000..92ba61ae --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfig.html @@ -0,0 +1,1001 @@ + + + + TzKTBakerConfig Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerConfig

+
+
+ +
public struct TzKTBakerConfig : Codable
+ +
+
+

The bakers config file for details on when fees, min delegation etc change

+ +
+
+
+
    +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let address: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fee: [TzKTBakerConfigDoubleValue]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + minDelegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let minDelegation: [TzKTBakerConfigDoubleValue]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + payoutDelay + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let payoutDelay: [TzKTBakerConfigIntValue]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + rewardStruct + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let rewardStruct: [TzKTBakerConfigIntValue]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + latesetFee() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func latesetFee() -> Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + feeForCycle(cycle:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func feeForCycle(cycle: Int) -> Double
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + latestPayoutDelay() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func latestPayoutDelay() -> Int
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func payoutDelayForCycle(cycle: Int) -> Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + latestRewardStruct() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func latestRewardStruct() -> Int?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfigDoubleValue.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfigDoubleValue.html new file mode 100644 index 00000000..741e7cae --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfigDoubleValue.html @@ -0,0 +1,792 @@ + + + + TzKTBakerConfigDoubleValue Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerConfigDoubleValue

+
+
+ +
public struct TzKTBakerConfigDoubleValue : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + cycle + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cycle: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: Double
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfigIntValue.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfigIntValue.html new file mode 100644 index 00000000..b9e45585 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfigIntValue.html @@ -0,0 +1,792 @@ + + + + TzKTBakerConfigIntValue Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerConfigIntValue

+
+
+ +
public struct TzKTBakerConfigIntValue : Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + cycle + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cycle: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfigRewardStruct.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfigRewardStruct.html new file mode 100644 index 00000000..ad1f2758 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBakerConfigRewardStruct.html @@ -0,0 +1,1028 @@ + + + + TzKTBakerConfigRewardStruct Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBakerConfigRewardStruct

+
+
+ +
public struct TzKTBakerConfigRewardStruct : Codable
+ +
+
+

Baker config payout flags

+ +
+
+
+
    +
  • +
    + + + + blocks + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let blocks: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedBlocks + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedBlocks: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endorsements + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let endorsements: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedEndorsements + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedEndorsements: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fees + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let fees: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedFees + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedFees: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + accusationRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let accusationRewards: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + accusationLosses + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let accusationLosses: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + revelationRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let revelationRewards: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + revelationLosses + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let revelationLosses: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + fromConfigInt(_:) + +
    +
    +
    +
    +
    +
    +

    Convert the 14-bit number in the baker config, to the equivalent set of flags

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func fromConfigInt(_ config: Int) -> TzKTBakerConfigRewardStruct
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalance.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalance.html new file mode 100644 index 00000000..79d505ea --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalance.html @@ -0,0 +1,901 @@ + + + + TzKTBalance Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalance

+
+
+ +
public struct TzKTBalance : Codable
+ +
+
+

Model mapping to the Balance object returned from the new TzKT API, resulting from the merge of BCD and TzKT

+ +
+
+
+
    +
  • +
    + + + + exceptionListNFT + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let exceptionListNFT: [String]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    +

    String containing the RPC respresetnation of the balance of the given token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    +

    Details about the Token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token: TzKTBalanceToken
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenAmount + +
    +
    +
    +
    +
    +
    +

    Helper to convert the RPC token balance to a TokenAmount object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tokenAmount: TokenAmount { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isNFT() + +
    +
    +
    +
    +
    +
    +

    Basic check to see if token is an NFT or not. May not be 100% successful, needs research

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isNFT() -> Bool
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isOnNFTExceptionList() -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadata.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadata.html new file mode 100644 index 00000000..890c269f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadata.html @@ -0,0 +1,1308 @@ + + + + TzKTBalanceMetadata Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceMetadata

+
+
+ +
public struct TzKTBalanceMetadata : Codable
+ +
+
+

Metadata object for the token

+ +
+
+
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    A human readbale name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var name: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + symbol + +
    +
    +
    +
    +
    +
    +

    The tokens symbol

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var symbol: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimals + +
    +
    +
    +
    +
    +
    +

    The number of decimals the token has

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimals: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + decimalsInt + +
    +
    +
    +
    +
    +
    +

    Helper to convert the decimals to an Int

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var decimalsInt: Int { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + formats + +
    +
    +
    +
    +
    +
    +

    Details of the available formats that the media is available in

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var formats: [TzKTBalanceMetadataFormat]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + displayUri + +
    +
    +
    +
    +
    +
    +

    URI to an medium/large image owned by the contract

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var displayUri: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + artifactUri + +
    +
    +
    +
    +
    +
    +

    URI to the raw media artifact owned by the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var artifactUri: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + thumbnailUri + +
    +
    +
    +
    +
    +
    +

    URI to an small image for the token, ususally used as an icon when displayed in lists

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var thumbnailUri: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Description of the token or NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mintingTool + +
    +
    +
    +
    +
    +
    +

    URL to the tool that was used to mint the item

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var mintingTool: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tags + +
    +
    +
    +
    +
    +
    +

    A list of tags to categorize the token / NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tags: [String]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + minter + +
    +
    +
    +
    +
    +
    +

    The address responsible for creating the token / NFT

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var minter: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + shouldPreferSymbol + +
    +
    +
    +
    +
    +
    +

    Whether or not the symbol or the name is prefered when displaying the token / NFT in a list

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var shouldPreferSymbol: Bool?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + attributes + +
    +
    +
    +
    +
    +
    +

    A collection of attributes about the token/NFT. Although TZIP-16 intended for this to be filled with info such as license, version, possible error messages etc, +It has been adopted by NFT creators as a more free-form dictionary. An example would be for gaming NFT’s, this might be a list of attack/defensive moves the character is able to use +It is extremely likely that the actual type will be [[String: String]], however due to various issues and complexities of using a strongly typed language like Swift, +the easiest solution was to use [Any] with a custom decoder

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var attributes: [Any]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ttl + +
    +
    +
    +
    +
    +
    +

    Flag, in seconds, indicating how long to wait before refreshing the token to update its metadata. E.g. fxHash will inject a token with a name “[Waiting to be Signed]”. and then, all things going well, 30 seconds later its updated to the correct attributes

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let ttl: Int?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(name: String?, symbol: String?, decimals: String, formats: [TzKTBalanceMetadataFormat]?, displayUri: String?, artifactUri: String?, thumbnailUri: String?, description: String?, mintingTool: String?, tags: [String]?, minter: String?, shouldPreferSymbol: Bool?, attributes: [Any]?, ttl: Int?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + thumbnailURL + +
    +
    +
    +
    +
    +
    +

    Helper to run the URI through the MediaProxyService to generate a useable URL for the thumbnail (if available)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var thumbnailURL: URL? { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + displayURL + +
    +
    +
    +
    +
    +
    +

    Helper to run the URI through the MediaProxyService to generate a useable URL for the display image (if available)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var displayURL: URL? { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Attributes is a complex free-form object. In a lot of cases when NFT’s are games / collectibles, it should be possible to convert most if not all the elements into more simple String: String key value pairs, which will be easier to manage in table / collection views

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getKeyValuesFromAttributes() -> [TzKTBalanceMetadataAttributeKeyValue]
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadataAttributeKeyValue.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadataAttributeKeyValue.html new file mode 100644 index 00000000..9aa8c9d9 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadataAttributeKeyValue.html @@ -0,0 +1,819 @@ + + + + TzKTBalanceMetadataAttributeKeyValue Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceMetadataAttributeKeyValue

+
+
+ +
public struct TzKTBalanceMetadataAttributeKeyValue : Codable, Hashable
+ +
+
+

Wrapper / Helper to extract metadata attribute content

+ +
+
+
+
    +
  • +
    + + + + key + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let key: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(key:value:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(key: String, value: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadataDimensions.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadataDimensions.html new file mode 100644 index 00000000..39db578e --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadataDimensions.html @@ -0,0 +1,822 @@ + + + + TzKTBalanceMetadataDimensions Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceMetadataDimensions

+
+
+ +
public struct TzKTBalanceMetadataDimensions : Codable
+ +
+
+

Object containing information about the dimensions of a given piece of media

+ +
+
+
+
    +
  • +
    + + + + unit + +
    +
    +
    +
    +
    +
    +

    The unit of measurement (e.g. px for pixels)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let unit: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    String containing the resolution or size (e.g. 1024x787)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let value: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(unit:value:) + +
    +
    +
    +
    +
    +
    +

    Init to manaually create an instance, mostly for testing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(unit: String, value: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadataFormat.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadataFormat.html new file mode 100644 index 00000000..d57a9e27 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceMetadataFormat.html @@ -0,0 +1,849 @@ + + + + TzKTBalanceMetadataFormat Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceMetadataFormat

+
+
+ +
public struct TzKTBalanceMetadataFormat : Codable
+ +
+
+

Object containing information about the various formats the media is available in

+ +
+
+
+
    +
  • +
    + + + + uri + +
    +
    +
    +
    +
    +
    +

    The URI to this specific format

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let uri: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mimeType + +
    +
    +
    +
    +
    +
    +

    The mimetype of this version

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let mimeType: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + dimensions + +
    +
    +
    +
    +
    +
    +

    The display dimensions

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let dimensions: TzKTBalanceMetadataDimensions?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Init to manaually create an instance, mostly for testing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(uri: String, mimeType: String, dimensions: TzKTBalanceMetadataDimensions?)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceToken.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceToken.html new file mode 100644 index 00000000..ccbdffc3 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTBalanceToken.html @@ -0,0 +1,1007 @@ + + + + TzKTBalanceToken Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTBalanceToken

+
+
+ +
public struct TzKTBalanceToken : Codable
+ +
+
+

Model encapsulating information about the token itself

+ +
+
+
+
    +
  • +
    + + + + contract + +
    +
    +
    +
    +
    +
    +

    Details of the contract (e.g. address)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let contract: TzKTAddress
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenId + +
    +
    +
    +
    +
    +
    +

    The FA2 token ID of the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenId: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + standard + +
    +
    +
    +
    +
    +
    +

    Which FA version the token conforms too

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let standard: FaVersion
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + totalSupply + +
    +
    +
    +
    +
    +
    +

    Total avaialble supply of this address + token id combo

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let totalSupply: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Metadata about the token

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var metadata: TzKTBalanceMetadata?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + malformedMetadata + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var malformedMetadata: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + displaySymbol + +
    +
    +
    +
    +
    +
    +

    Helper to determine what string is used as the symbol for display purposes

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var displaySymbol: String { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(contract: TzKTAddress, tokenId: String, standard: FaVersion, totalSupply: String?, metadata: TzKTBalanceMetadata?)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + init(from:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init(from decoder: Decoder) throws
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + encode(to:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func encode(to encoder: Encoder) throws
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTCycle.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTCycle.html new file mode 100644 index 00000000..5e7e7c0b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTCycle.html @@ -0,0 +1,923 @@ + + + + TzKTCycle Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTCycle

+
+
+ +
public struct TzKTCycle : Codable
+ +
+
+

The blockchain is broken down into cycles that last 2.7 days. Baker payment logic resolves around cycles instead of blocks

+ +
+
+
+
    +
  • +
    + + + + index + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let index: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + startTime + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let startTime: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + firstLevel + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let firstLevel: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endTime + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let endTime: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + lastLevel + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let lastLevel: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + stateDate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var stateDate: Date? { get }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endDate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var endDate: Date? { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTDelegatorReward.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTDelegatorReward.html new file mode 100644 index 00000000..15e37cf6 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTDelegatorReward.html @@ -0,0 +1,1132 @@ + + + + TzKTDelegatorReward Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTDelegatorReward

+
+
+ +
public struct TzKTDelegatorReward : Codable
+ +
+
+

An object containing info on the reward a delegator should receive from a baker

+ +
+
+
+
    +
  • +
    + + + + cycle + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let cycle: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + balance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let balance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + baker + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let baker: TzKTAddress
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + stakingBalance + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let stakingBalance: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + blockRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let blockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedBlockRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedBlockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + endorsementRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let endorsementRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedEndorsementRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + blockFees + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let blockFees: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + missedBlockFees + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedBlockFees: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + extraBlockRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let extraBlockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let missedExtraBlockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + futureBlockRewards + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let futureBlockRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let futureEndorsementRewards: Decimal
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Return an estimated either for potential future or actual rewards

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func estimatedReward(withFee fee: Double, andRewardStruct: TzKTBakerConfigRewardStruct?) -> XTZAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTOperation.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTOperation.html new file mode 100644 index 00000000..4a33ee57 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTOperation.html @@ -0,0 +1,1038 @@ + + + + TzKTOperation Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTOperation

+
+
+ +
public struct TzKTOperation : Codable
+ +
+
+

A model matching the response that comes back from TzKT’s API: v1/operations/<operation-hash>

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    Type of operation (e.g. transaction, delegation, reveal etc)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    +

    Unique id to denote the operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    +

    The block level it was injected at

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    +

    Timestamp it was injected at

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + block + +
    +
    +
    +
    +
    +
    +

    The hash of the injected block

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let block: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    +

    The operation hash

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    +

    The users numerical counter of the operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let counter: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    Status of the operation (e.g. applied or failed)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let status: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    +

    Optional array of errors encountered while trying to inject the operation

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errors: [TzKTOperationError]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + isFailed() + +
    +
    +
    +
    +
    +
    +

    Helper to detect a failed transation by searching for a status of “failed”, “backtracked” or “skipped”

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func isFailed() -> Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + containsError() + +
    +
    +
    +
    +
    +
    +

    Helper to detect if this operation contains an error

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func containsError() -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTOperationError.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTOperationError.html new file mode 100644 index 00000000..49e172fe --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTOperationError.html @@ -0,0 +1,768 @@ + + + + TzKTOperationError Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTOperationError

+
+
+ +
public struct TzKTOperationError : Codable
+ +
+
+

TzKT’s more basic error object response

+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The RPC error type string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: String
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTokenTransfer.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTokenTransfer.html new file mode 100644 index 00000000..0ba9ff99 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTokenTransfer.html @@ -0,0 +1,1027 @@ + + + + TzKTTokenTransfer Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTTokenTransfer

+
+
+ +
public struct TzKTTokenTransfer : Codable
+ +
+
+

FA1.2 / FA2 token transafers are treated differently from transactions. This object is used when fetching data form the API, as a temporary placeholder, ultimately to be merged into the transactions

+ +
+
+
+
    +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var hash: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + token + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let token: TzKTBalanceToken
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + to + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let to: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + from + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let from: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let amount: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + transactionId + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let transactionId: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + mintingTool + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let mintingTool: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenAmount() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func tokenAmount() -> TokenAmount
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction.html new file mode 100644 index 00000000..3a862654 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction.html @@ -0,0 +1,2131 @@ + + + + TzKTTransaction Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTTransaction

+
+
+ +
public struct TzKTTransaction : Codable, CustomStringConvertible, Hashable, Identifiable
+ +
+
+

A model matching the response that comes back from TzKT’s API: v1/accounts/<address>/operations

+ +
+
+
+
    +
  • +
    + + + + dateFormatter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static let dateFormatter: DateFormatter
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Types +

+
+
+
    +
  • +
    + + + + TransactionStatus + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TransactionStatus : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TransactionType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TransactionType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TransactionSubType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public enum TransactionSubType : String, Codable
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + TransactionError + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public struct TransactionError : Codable
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let type: TransactionType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let id: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let level: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let timestamp: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let counter: Decimal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + initiater + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let initiater: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + sender + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let sender: TzKTAddress
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bakerFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var bakerFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + storageFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var storageFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allocationFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var allocationFee: XTZAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + target + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var target: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + prevDelegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let prevDelegate: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + newDelegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let newDelegate: TzKTAddress?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var amount: TokenAmount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parameter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let parameter: [String : String]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let status: TransactionStatus
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hasInternals + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hasInternals: Bool
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenTransfersCount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let tokenTransfersCount: Decimal?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let errors: [TransactionError]?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + date + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let date: Date?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tzktTokenTransfer + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var tzktTokenTransfer: TzKTTokenTransfer? { get set }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + subType + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var subType: TransactionSubType?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + entrypointCalled + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var entrypointCalled: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + primaryToken + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var primaryToken: Token?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

CustomStringConvertible +

+
+
+
    +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Hashable +

+
+
+
    +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: TzKTTransaction, rhs: TzKTTransaction) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Codable Protocol +

+
+
+ +
+
+
+ + +
+ +

Helpers +

+
+
+
    +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parameterValueAsArray() -> [Any]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parameterValueAsDict() -> [String : Any]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parameterValueAsArrayOfDictionary() -> [[String : Any]]?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func parameterValueAsType<T>(type: T.Type) -> T?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + getEntrypoint() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getEntrypoint() -> String?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public mutating func processAdditionalData(withCurrentWalletAddress currentWalletAddress: String)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + createPrimaryToken() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func createPrimaryToken() -> Token?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    The TzKT transaction API doesn’t provide all the info needed to normalise Token amounts. It only gives address and rpc amount. +Burried inside the michelson, the dex contract needs to be told the token id, and the target will contain the address. +This function will try to extract address, token id and rpc amount and return them in the standard objects, so that they can be used in conjuction with other functions to fetch the decimal data. +e.g. DipDup client can fetch all tokens from dexes, containing all token info. Using the address and id, the rest could be found via that, assuming zero for anything else (such as NFTs)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getFaTokenTransferData() -> Token?
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func getTokenTransferDestination() -> String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errorString() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func errorString() -> String?
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/CodingKeys.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/CodingKeys.html new file mode 100644 index 00000000..c5d0722c --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/CodingKeys.html @@ -0,0 +1,1338 @@ + + + + CodingKeys Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

CodingKeys

+
+
+ +
public enum CodingKeys : String, CodingKey
+ +
+
+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case type
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case id
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + level + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case level
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + timestamp + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case timestamp
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case hash
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + counter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case counter
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + initiater + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case initiater
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + sender + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case sender
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + bakerFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case bakerFee
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + storageFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case storageFee
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + allocationFee + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case allocationFee
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + target + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case target
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + prevDelegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case prevDelegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + newDelegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case newDelegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case amount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + parameter + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case parameter
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case status
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + subType + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case subType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + entrypointCalled + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case entrypointCalled
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + primaryToken + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case primaryToken
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hasInternals + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case hasInternals
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + tokenTransfersCount + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case tokenTransfersCount
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + errors + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case errors
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/TransactionStatus.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/TransactionStatus.html new file mode 100644 index 00000000..0f41684b --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/TransactionStatus.html @@ -0,0 +1,922 @@ + + + + TransactionStatus Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TransactionStatus

+
+
+ +
public enum TransactionStatus : String, Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + applied + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case applied
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + failed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case failed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + backtracked + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case backtracked
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unconfirmed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unconfirmed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + partiallyConfirmed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case partiallyConfirmed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + confirmed + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case confirmed
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/TransactionSubType.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/TransactionSubType.html new file mode 100644 index 00000000..e36abed1 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/TransactionSubType.html @@ -0,0 +1,922 @@ + + + + TransactionSubType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TransactionSubType

+
+
+ +
public enum TransactionSubType : String, Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + send + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case send
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + receive + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case receive
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case delegate
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reveal + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case reveal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + exchange + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case exchange
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + contractCall + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case contractCall
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/TransactionType.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/TransactionType.html new file mode 100644 index 00000000..8cda660f --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransaction/TransactionType.html @@ -0,0 +1,870 @@ + + + + TransactionType Enumeration Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TransactionType

+
+
+ +
public enum TransactionType : String, Codable
+ +
+
+ +
+
+
+
    +
  • +
    + + + + delegation + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case delegation
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + origination + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case origination
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + transaction + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case transaction
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + reveal + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case reveal
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    case unknown
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransactionGroup.html b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransactionGroup.html new file mode 100644 index 00000000..29cb18f5 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/TzKTTransactionGroup.html @@ -0,0 +1,1089 @@ + + + + TzKTTransactionGroup Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

TzKTTransactionGroup

+
+
+ +
public struct TzKTTransactionGroup : Codable, Hashable, Identifiable, CustomStringConvertible
+ +
+
+

Artifical object used to group related transactions into a more user friendly display +For example, 1 contract call can reuslt in many transactions being returned. To avoid the users UI being clogged, we group all them into 1 group, so the user only needs to see 1 item for 1 action they performed

+ +
+
+
+
+ + +
+ +

Properties +

+
+
+
    +
  • +
    + + + + groupType + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var groupType: TzKTTransaction.TransactionSubType
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + hash + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let hash: String
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + transactions + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let transactions: [TzKTTransaction]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public let status: TzKTTransaction.TransactionStatus
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + primaryToken + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var primaryToken: Token?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + secondaryToken + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var secondaryToken: Token?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + entrypointCalled + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var entrypointCalled: String?
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + id + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var id: Decimal { get }
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public init?(withTransactions transactions: [TzKTTransaction], currentWalletAddress: String)
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

CustomStringConvertible +

+
+
+
    +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var description: String { get }
    + +
    +
    +
    +
    +
  • +
+
+
+
+ + +
+ +

Hashable +

+
+
+
    +
  • +
    + + + + hash(into:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func hash(into hasher: inout Hasher)
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + ==(_:_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func == (lhs: TzKTTransactionGroup, rhs: TzKTTransactionGroup) -> Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/WalletMetadata.html b/docsets/.docset/Contents/Resources/Documents/Structs/WalletMetadata.html new file mode 100644 index 00000000..f1b69982 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/WalletMetadata.html @@ -0,0 +1,1313 @@ + + + + WalletMetadata Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletMetadata

+
+
+ +
public struct WalletMetadata : Codable, Hashable
+ +
+
+

Object to store UI related info about wallets, seperated from the wallet object itself to avoid issues merging together

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Structs/WalletMetadataList.html b/docsets/.docset/Contents/Resources/Documents/Structs/WalletMetadataList.html new file mode 100644 index 00000000..9c120ab9 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Structs/WalletMetadataList.html @@ -0,0 +1,1157 @@ + + + + WalletMetadataList Structure Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

WalletMetadataList

+
+
+ +
public struct WalletMetadataList : Codable, Hashable
+ +
+
+

Container to store groups of WalletMetadata based on type

+ +
+
+
+ +
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/Typealiases.html b/docsets/.docset/Contents/Resources/Documents/Typealiases.html new file mode 100644 index 00000000..8f281130 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/Typealiases.html @@ -0,0 +1,834 @@ + + + + Type Aliases Reference + + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+

Type Aliases

+

The following type aliases are available globally.

+ +
+
+
+
    +
  • +
    + + + + UIImage + +
    +
    +
    +
    +
    +
    +

    Create “UIImage” as typealias of NSImage

    + +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper object around the network response

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias QuipuswapExchangeLedgerKeyResponse = [QuipuswapExchangeLedgerKey]
    + +
    +
    +
    +
    +
  • +
  • + +
    +
    +
    +
    +
    +

    Wrapper object around the network response

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias QuipuswapExchangeUserRewardsKeyResponse = [QuipuswapExchangeUserRewardsKey]
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + NanoTez + +
    +
    +
    +
    +
    +
    +

    typealias to make it clearer when we are using NanoTez, which only is only used for fee calcualtion

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias NanoTez = Int
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/css/highlight.css b/docsets/.docset/Contents/Resources/Documents/css/highlight.css new file mode 100644 index 00000000..c170357c --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docsets/.docset/Contents/Resources/Documents/css/jazzy.css b/docsets/.docset/Contents/Resources/Documents/css/jazzy.css new file mode 100644 index 00000000..2e387139 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/css/jazzy.css @@ -0,0 +1,439 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td { + background: transparent; + border: 0; + margin: 0; + outline: 0; + padding: 0; + vertical-align: baseline; } + +body { + background-color: #f2f2f2; + font-family: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + -webkit-font-smoothing: subpixel-antialiased; + word-wrap: break-word; } + +h1, h2, h3 { + margin-top: 0.8em; + margin-bottom: 0.3em; + font-weight: 100; + color: black; } + +h1 { + font-size: 2.5em; } + +h2 { + font-size: 2em; + border-bottom: 1px solid #e2e2e2; } + +h4 { + font-size: 13px; + line-height: 1.5; + margin-top: 21px; } + +h5 { + font-size: 1.1em; } + +h6 { + font-size: 1.1em; + color: #777; } + +.section-name { + color: gray; + display: block; + font-family: Helvetica; + font-size: 22px; + font-weight: 100; + margin-bottom: 15px; } + +pre, code { + font: 0.95em Menlo, monospace; + color: #777; + word-wrap: normal; } + +p code, li code { + background-color: #eee; + padding: 2px 4px; + border-radius: 4px; } + +pre > code { + padding: 0; } + +a { + color: #0088cc; + text-decoration: none; } + a code { + color: inherit; } + +ul { + padding-left: 15px; } + +li { + line-height: 1.8em; } + +img { + max-width: 100%; } + +blockquote { + margin-left: 0; + padding: 0 10px; + border-left: 4px solid #ccc; } + +hr { + height: 1px; + border: none; + background-color: #e2e2e2; } + +.footnote-ref { + display: inline-block; + scroll-margin-top: 70px; } + +.footnote-def { + scroll-margin-top: 70px; } + +.content-wrapper { + margin: 0 auto; + width: 980px; } + +header { + font-size: 0.85em; + line-height: 32px; + background-color: #414141; + position: fixed; + width: 100%; + z-index: 3; } + header img { + padding-right: 6px; + vertical-align: -3px; + height: 16px; } + header a { + color: #fff; } + header p { + float: left; + color: #999; } + header .header-right { + float: right; + margin-left: 16px; } + +#breadcrumbs { + background-color: #f2f2f2; + height: 21px; + padding-top: 17px; + position: fixed; + width: 100%; + z-index: 2; + margin-top: 32px; } + #breadcrumbs #carat { + height: 10px; + margin: 0 5px; } + +.sidebar { + background-color: #f9f9f9; + border: 1px solid #e2e2e2; + overflow-y: auto; + overflow-x: hidden; + position: fixed; + top: 70px; + bottom: 0; + width: 230px; + word-wrap: normal; } + +.nav-groups { + list-style-type: none; + background: #fff; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #e2e2e2; + font-size: 1.1em; + font-weight: 100; + padding: 15px 0 15px 20px; } + .nav-group-name > a { + color: #333; } + +.nav-group-tasks { + margin-top: 5px; } + +.nav-group-task { + font-size: 0.9em; + list-style-type: none; + white-space: nowrap; } + .nav-group-task a { + color: #888; } + +.main-content { + background-color: #fff; + border: 1px solid #e2e2e2; + margin-left: 246px; + position: absolute; + overflow: hidden; + padding-bottom: 20px; + top: 70px; + width: 734px; } + .main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote { + margin-bottom: 1em; } + .main-content p { + line-height: 1.8em; } + .main-content section .section:first-child { + margin-top: 0; + padding-top: 0; } + .main-content section .task-group-section .task-group:first-of-type { + padding-top: 10px; } + .main-content section .task-group-section .task-group:first-of-type .section-name { + padding-top: 15px; } + .main-content section .heading:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + .main-content .section-name p { + margin-bottom: inherit; + line-height: inherit; } + .main-content .section-name code { + background-color: inherit; + padding: inherit; + color: inherit; } + +.section { + padding: 0 25px; } + +.highlight { + background-color: #eee; + padding: 10px 12px; + border: 1px solid #e2e2e2; + border-radius: 4px; + overflow-x: auto; } + +.declaration .highlight { + overflow-x: initial; + padding: 0 40px 40px 0; + margin-bottom: -25px; + background-color: transparent; + border: none; } + +.section-name { + margin: 0; + margin-left: 18px; } + +.task-group-section { + margin-top: 10px; + padding-left: 6px; + border-top: 1px solid #e2e2e2; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + +.section-name-container { + position: relative; + display: inline-block; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } + .item code { + background-color: transparent; + padding: 0; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 35px; + font-size: 11.9px; + transition: all 300ms; } + .item .token-open { + margin-left: 20px; } + .item .discouraged { + text-decoration: line-through; } + .item .declaration-note { + font-size: .85em; + color: gray; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #e2e2e2; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + background: #f9f9f9; + border-left: 1px solid #e2e2e2; + border-top: 1px solid #e2e2e2; + height: 12px; + left: 21px; + top: -7px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + position: absolute; + width: 12px; } + +.height-container { + display: none; + left: -25px; + padding: 0 25px; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #f9f9f9; + border-bottom: 1px solid #e2e2e2; + left: -25px; + position: relative; + width: 100%; + padding-top: 10px; + padding-bottom: 5px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4b8afb; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #e2e2e2; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +#footer { + position: relative; + top: 10px; + bottom: 0px; + margin-left: 25px; } + #footer p { + margin: 0; + color: #aaa; + font-size: 0.8em; } + +html.dash header, html.dash #breadcrumbs, html.dash .sidebar { + display: none; } + +html.dash .main-content { + width: 980px; + margin-left: 0; + border: none; + width: 100%; + top: 0; + padding-bottom: 0; } + +html.dash .height-container { + display: block; } + +html.dash .item .token { + margin-left: 0; } + +html.dash .content-wrapper { + width: auto; } + +html.dash #footer { + position: static; } + +form[role=search] { + float: right; } + form[role=search] input { + font: Helvetica, freesans, Arial, sans-serif; + margin-top: 6px; + font-size: 13px; + line-height: 20px; + padding: 0px 10px; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fff; + color: #333; + border: 1px solid #e2e2e2; + z-index: 4; } + form[role=search] .tt-highlight { + font-weight: bold; } + form[role=search] .tt-suggestion { + font: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + form[role=search] .tt-suggestion:hover, + form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + form[role=search] .tt-suggestion:hover .doc-parent-name, + form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docsets/.docset/Contents/Resources/Documents/img/carat.png b/docsets/.docset/Contents/Resources/Documents/img/carat.png new file mode 100755 index 00000000..29d2f7fd Binary files /dev/null and b/docsets/.docset/Contents/Resources/Documents/img/carat.png differ diff --git a/docsets/.docset/Contents/Resources/Documents/img/dash.png b/docsets/.docset/Contents/Resources/Documents/img/dash.png new file mode 100755 index 00000000..6f694c7a Binary files /dev/null and b/docsets/.docset/Contents/Resources/Documents/img/dash.png differ diff --git a/docsets/.docset/Contents/Resources/Documents/img/spinner.gif b/docsets/.docset/Contents/Resources/Documents/img/spinner.gif new file mode 100644 index 00000000..e3038d0a Binary files /dev/null and b/docsets/.docset/Contents/Resources/Documents/img/spinner.gif differ diff --git a/docsets/.docset/Contents/Resources/Documents/index.html b/docsets/.docset/Contents/Resources/Documents/index.html new file mode 100644 index 00000000..f1df22e4 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/index.html @@ -0,0 +1,826 @@ + + + + Reference + + + + + + + + + + + + +
+
+

Docs (100% documented)

+

DashInstall in Dash

+
+
+ +
+
+
+
+
+ +
+
+ +
+
+
+ +

Kukai Core Swift

+ +

Platforms +Swift Package Manager +License

+ +

Kukai Core Swift is a native Swift library for interacting with the Tezos blockchain and other applications in the Tezos ecosystem, such as the Tezos Node RPC, the indexer TzKT, the smart contract explorer Better Call Dev, the API from the NFT marketplace OBJKT.com etc.

+ +

The purpose of this SDK is not to provide a complete feature set for every aspect of Tezos, instead it is the base building block for the Kukai iOS mobile app, that we open source and make avaialble for anyone looking for similar functionality. We are open to accepting PR’s and discussing changes/features. However if its not related to the kuaki mobile app, such work is likely better suited in a standalone package, with this as a dependency.

+ +


+ +

Feature set includes:

+ +
    +
  • Create Regular and HD wallets
  • +
  • A service to cache and retrieve encrypted wallet details from disk, using the secure enclave
  • +
  • Fetching a wallet’s XTZ balance, all FA token balances, owned NFT’s grouped together by type, all in a single function call
  • +
  • Fetching transaction history, including token transfers
  • +
  • Remote forging using a second node or Local forging via @taquito/local-forging + +
      +
    • Using a “vanilla” javascript version of the local-forging package specifically. These JS files can be found under the taquito github releases, under assets, named taquito-local-forging-vanilla.zip. e.g. here
    • +
    • Created using this webpack config as a starting point
    • +
  • +
  • Estimating Gas, Storage and Fees for operations
  • +
  • Fetch Tezos domains from addresses, and addresses from domains
  • +
  • Media proxy tools for dealing with collectible and token images
  • +
  • Helpers for dealing with Michelson JSON
  • +
  • Helpers for parsing contents of Operations
  • +
  • Helpers for parsing errors
  • +
  • Dex fee + return calculation
  • +
+ +


+

+

Install

+ +

Kukai Core Swift supports the Swift Package Manager. Either use the Xcode editor to add to your project by clicking File -> Swift Packages -> Add Package Dependency, search for the git repo https://github.com/kukai-wallet/kukai-core-swift.git and choose from version x.x.x (see tags for latest).

+ +

Or add it to your Package.swift dependencies like so:

+
dependencies: [
+    .package(url: "https://github.com/kukai-wallet/kukai-core-swift", from: "x.x.x")
+]
+
+ +


+

+

How to use

+ +

Wallets are created using dedicated classes for each type, conforming to the Wallet protocol. Wallets are created using Mnemonic objects, see Kukai Crypto Swift for more details on those

+ +
    +
  • RegularWallet + +
      +
    • Created using a Mnemonic, an optional passphrase, and optionally specify the EllipticalCurve you want (ed25519 for TZ1…, secp256k1 for TZ2…)
    • +
  • +
  • HDWallet + +
      +
    • Created using a Mnemonic, an optional passphrase, and an optional BIP 44 derivation path
    • +
  • +
+ +


+ +

The main functionality centres around client classes and a factory:

+ +
    +
  • TezosNodeClient + +
      +
    • Query details about the node
    • +
    • Estimate fees via the node RPC
    • +
    • Send operations
    • +
  • +
  • TzKTClient + +
      +
    • Fetching balances
    • +
    • Transaction history
    • +
    • Determining if an operation has been successfully injected
    • +
  • +
  • OperationFactory + +
      +
    • Helper methods to create arrays of operations needed for common tasks
    • +
  • +
+ +


+ +

For working example, see the kukai mobile ios app here

+ +


+

+

Documentation

+ +

Compiled Swift Doc’s can be found here

+ +
+
+ +
+
+ + diff --git a/docsets/.docset/Contents/Resources/Documents/js/jazzy.js b/docsets/.docset/Contents/Resources/Documents/js/jazzy.js new file mode 100755 index 00000000..19844166 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/docsets/.docset/Contents/Resources/Documents/js/jazzy.search.js b/docsets/.docset/Contents/Resources/Documents/js/jazzy.search.js new file mode 100644 index 00000000..359cdbb8 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
'; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
'; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/docsets/.docset/Contents/Resources/Documents/js/jquery.min.js b/docsets/.docset/Contents/Resources/Documents/js/jquery.min.js new file mode 100644 index 00000000..7f37b5d9 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.7.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.1",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+ge+")"+ge+"*"),x=new RegExp(ge+"|>"),j=new RegExp(g),A=new RegExp("^"+t+"$"),D={ID:new RegExp("^#("+t+")"),CLASS:new RegExp("^\\.("+t+")"),TAG:new RegExp("^("+t+"|[*])"),ATTR:new RegExp("^"+p),PSEUDO:new RegExp("^"+g),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ge+"*(even|odd|(([+-]|)(\\d*)n|)"+ge+"*(?:([+-]|)"+ge+"*(\\d+)|))"+ge+"*\\)|)","i"),bool:new RegExp("^(?:"+f+")$","i"),needsContext:new RegExp("^"+ge+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ge+"*((?:-\\d)?\\d*)"+ge+"*\\)|)(?=[^-]|$)","i")},N=/^(?:input|select|textarea|button)$/i,q=/^h\d$/i,L=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,H=/[+~]/,O=new RegExp("\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\([^\\r\\n\\f])","g"),P=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},M=function(){V()},R=J(function(e){return!0===e.disabled&&fe(e,"fieldset")},{dir:"parentNode",next:"legend"});try{k.apply(oe=ae.call(ye.childNodes),ye.childNodes),oe[ye.childNodes.length].nodeType}catch(e){k={apply:function(e,t){me.apply(e,ae.call(t))},call:function(e){me.apply(e,ae.call(arguments,1))}}}function I(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(V(e),e=e||T,C)){if(11!==p&&(u=L.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return k.call(n,a),n}else if(f&&(a=f.getElementById(i))&&I.contains(e,a)&&a.id===i)return k.call(n,a),n}else{if(u[2])return k.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&e.getElementsByClassName)return k.apply(n,e.getElementsByClassName(i)),n}if(!(h[t+" "]||d&&d.test(t))){if(c=t,f=e,1===p&&(x.test(t)||m.test(t))){(f=H.test(t)&&U(e.parentNode)||e)==e&&le.scope||((s=e.getAttribute("id"))?s=ce.escapeSelector(s):e.setAttribute("id",s=S)),o=(l=Y(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+Q(l[o]);c=l.join(",")}try{return k.apply(n,f.querySelectorAll(c)),n}catch(e){h(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return re(t.replace(ve,"$1"),e,n,r)}function W(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function F(e){return e[S]=!0,e}function $(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function B(t){return function(e){return fe(e,"input")&&e.type===t}}function _(t){return function(e){return(fe(e,"input")||fe(e,"button"))&&e.type===t}}function z(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&R(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function X(a){return F(function(o){return o=+o,F(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function U(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}function V(e){var t,n=e?e.ownerDocument||e:ye;return n!=T&&9===n.nodeType&&n.documentElement&&(r=(T=n).documentElement,C=!ce.isXMLDoc(T),i=r.matches||r.webkitMatchesSelector||r.msMatchesSelector,r.msMatchesSelector&&ye!=T&&(t=T.defaultView)&&t.top!==t&&t.addEventListener("unload",M),le.getById=$(function(e){return r.appendChild(e).id=ce.expando,!T.getElementsByName||!T.getElementsByName(ce.expando).length}),le.disconnectedMatch=$(function(e){return i.call(e,"*")}),le.scope=$(function(){return T.querySelectorAll(":scope")}),le.cssHas=$(function(){try{return T.querySelector(":has(*,:jqfake)"),!1}catch(e){return!0}}),le.getById?(b.filter.ID=function(e){var t=e.replace(O,P);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(O,P);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):t.querySelectorAll(e)},b.find.CLASS=function(e,t){if("undefined"!=typeof t.getElementsByClassName&&C)return t.getElementsByClassName(e)},d=[],$(function(e){var t;r.appendChild(e).innerHTML="",e.querySelectorAll("[selected]").length||d.push("\\["+ge+"*(?:value|"+f+")"),e.querySelectorAll("[id~="+S+"-]").length||d.push("~="),e.querySelectorAll("a#"+S+"+*").length||d.push(".#.+[+~]"),e.querySelectorAll(":checked").length||d.push(":checked"),(t=T.createElement("input")).setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),r.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&d.push(":enabled",":disabled"),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||d.push("\\["+ge+"*name"+ge+"*="+ge+"*(?:''|\"\")")}),le.cssHas||d.push(":has"),d=d.length&&new RegExp(d.join("|")),l=function(e,t){if(e===t)return a=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!le.sortDetached&&t.compareDocumentPosition(e)===n?e===T||e.ownerDocument==ye&&I.contains(ye,e)?-1:t===T||t.ownerDocument==ye&&I.contains(ye,t)?1:o?se.call(o,e)-se.call(o,t):0:4&n?-1:1)}),T}for(e in I.matches=function(e,t){return I(e,null,null,t)},I.matchesSelector=function(e,t){if(V(e),C&&!h[t+" "]&&(!d||!d.test(t)))try{var n=i.call(e,t);if(n||le.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){h(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(O,P),e[3]=(e[3]||e[4]||e[5]||"").replace(O,P),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||I.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&I.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return D.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&j.test(n)&&(t=Y(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(O,P).toLowerCase();return"*"===e?function(){return!0}:function(e){return fe(e,t)}},CLASS:function(e){var t=s[e+" "];return t||(t=new RegExp("(^|"+ge+")"+e+"("+ge+"|$)"))&&s(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=I.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function T(e,n,r){return v(n)?ce.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?ce.grep(e,function(e){return e===n!==r}):"string"!=typeof n?ce.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(ce.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||k,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:S.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof ce?t[0]:t,ce.merge(this,ce.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:C,!0)),w.test(r[1])&&ce.isPlainObject(t))for(r in t)v(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=C.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):v(e)?void 0!==n.ready?n.ready(e):e(ce):ce.makeArray(e,this)}).prototype=ce.fn,k=ce(C);var E=/^(?:parents|prev(?:Until|All))/,j={children:!0,contents:!0,next:!0,prev:!0};function A(e,t){while((e=e[t])&&1!==e.nodeType);return e}ce.fn.extend({has:function(e){var t=ce(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,Ce=/^$|^module$|\/(?:java|ecma)script/i;xe=C.createDocumentFragment().appendChild(C.createElement("div")),(be=C.createElement("input")).setAttribute("type","radio"),be.setAttribute("checked","checked"),be.setAttribute("name","t"),xe.appendChild(be),le.checkClone=xe.cloneNode(!0).cloneNode(!0).lastChild.checked,xe.innerHTML="",le.noCloneChecked=!!xe.cloneNode(!0).lastChild.defaultValue,xe.innerHTML="",le.option=!!xe.lastChild;var ke={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function Se(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&fe(e,t)?ce.merge([e],n):n}function Ee(e,t){for(var n=0,r=e.length;n",""]);var je=/<|&#?\w+;/;function Ae(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function Re(e,t){return fe(e,"table")&&fe(11!==t.nodeType?t:t.firstChild,"tr")&&ce(e).children("tbody")[0]||e}function Ie(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function We(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Fe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(_.hasData(e)&&(s=_.get(e).events))for(i in _.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),C.head.appendChild(r[0])},abort:function(){i&&i()}}});var Jt,Kt=[],Zt=/(=)\?(?=&|$)|\?\?/;ce.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Kt.pop()||ce.expando+"_"+jt.guid++;return this[e]=!0,e}}),ce.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Zt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Zt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=v(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Zt,"$1"+r):!1!==e.jsonp&&(e.url+=(At.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||ce.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=ie[r],ie[r]=function(){o=arguments},n.always(function(){void 0===i?ce(ie).removeProp(r):ie[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Kt.push(r)),o&&v(i)&&i(o[0]),o=i=void 0}),"script"}),le.createHTMLDocument=((Jt=C.implementation.createHTMLDocument("").body).innerHTML="
",2===Jt.childNodes.length),ce.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(le.createHTMLDocument?((r=(t=C.implementation.createHTMLDocument("")).createElement("base")).href=C.location.href,t.head.appendChild(r)):t=C),o=!n&&[],(i=w.exec(e))?[t.createElement(i[1])]:(i=Ae([e],t,o),o&&o.length&&ce(o).remove(),ce.merge([],i.childNodes)));var r,i,o},ce.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(ce.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},ce.expr.pseudos.animated=function(t){return ce.grep(ce.timers,function(e){return t===e.elem}).length},ce.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=ce.css(e,"position"),c=ce(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=ce.css(e,"top"),u=ce.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),v(t)&&(t=t.call(e,n,ce.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},ce.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){ce.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===ce.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===ce.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=ce(e).offset()).top+=ce.css(e,"borderTopWidth",!0),i.left+=ce.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-ce.css(r,"marginTop",!0),left:t.left-i.left-ce.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===ce.css(e,"position"))e=e.offsetParent;return e||J})}}),ce.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;ce.fn[t]=function(e){return M(this,function(e,t,n){var r;if(y(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),ce.each(["top","left"],function(e,n){ce.cssHooks[n]=Ye(le.pixelPosition,function(e,t){if(t)return t=Ge(e,n),_e.test(t)?ce(e).position()[n]+"px":t})}),ce.each({Height:"height",Width:"width"},function(a,s){ce.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){ce.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return M(this,function(e,t,n){var r;return y(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?ce.css(e,t,i):ce.style(e,t,n,i)},s,n?e:void 0,n)}})}),ce.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){ce.fn[t]=function(e){return this.on(t,e)}}),ce.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.on("mouseenter",e).on("mouseleave",t||e)}}),ce.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){ce.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/docsets/.docset/Contents/Resources/Documents/js/typeahead.jquery.js b/docsets/.docset/Contents/Resources/Documents/js/typeahead.jquery.js new file mode 100644 index 00000000..3a2d2ab0 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/js/typeahead.jquery.js @@ -0,0 +1,1694 @@ +/*! + * typeahead.js 1.3.1 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Aa]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Bb]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Cc]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Dd]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ee]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflFf]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Gg]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Hh]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiIi]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼJj]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Kk]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflLl]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Mm]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Nn]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Oo]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Pp]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Qq]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Rr]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stSs]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstTt]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Uu]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Vv]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ww]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Xx]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Yy]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Zz]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
"); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
"); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
"); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
"); + $menu = this.menu.$node || $("
"); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/docsets/.docset/Contents/Resources/Documents/search.json b/docsets/.docset/Contents/Resources/Documents/search.json new file mode 100644 index 00000000..4f6e3502 --- /dev/null +++ b/docsets/.docset/Contents/Resources/Documents/search.json @@ -0,0 +1 @@ +{"Typealiases.html#/UIImage":{"name":"UIImage","abstract":"

Create “UIImage” as typealias of NSImage

"},"Typealiases.html#/s:14KukaiCoreSwift34QuipuswapExchangeLedgerKeyResponsea":{"name":"QuipuswapExchangeLedgerKeyResponse","abstract":"

Wrapper object around the network response

"},"Typealiases.html#/s:14KukaiCoreSwift39QuipuswapExchangeUserRewardsKeyResponsea":{"name":"QuipuswapExchangeUserRewardsKeyResponse","abstract":"

Wrapper object around the network response

"},"Typealiases.html#/s:14KukaiCoreSwift7NanoTeza":{"name":"NanoTez","abstract":"

typealias to make it clearer when we are using NanoTez, which only is only used for fee calcualtion

"},"Structs/SubverifierWrapper.html#/s:14KukaiCoreSwift18SubverifierWrapperV21aggregateVerifierNameSSSgvp":{"name":"aggregateVerifierName","abstract":"

The name of the aggregated verifier

","parent_name":"SubverifierWrapper"},"Structs/SubverifierWrapper.html#/s:14KukaiCoreSwift18SubverifierWrapperV11networkTypeAA21TezosNodeClientConfigV07NetworkG0Ovp":{"name":"networkType","abstract":"

Unlike seed based wallets, Torus verifiers are bound to a network and generate different addresses. In order to give the same experience on Tezos, we need to supply the network for each verifier

","parent_name":"SubverifierWrapper"},"Structs/SubverifierWrapper.html#/s:14KukaiCoreSwift18SubverifierWrapperV11subverifier10CustomAuth18SubVerifierDetailsVvp":{"name":"subverifier","abstract":"

The matching SubVerifierDetails object

","parent_name":"SubverifierWrapper"},"Structs/SubverifierWrapper.html#/s:14KukaiCoreSwift18SubverifierWrapperV21aggregateVerifierName11networkType11subverifierACSSSg_AA21TezosNodeClientConfigV07NetworkJ0O10CustomAuth03SubG7DetailsVtcfc":{"name":"init(aggregateVerifierName:networkType:subverifier:)","abstract":"

Create an instance of the object with an option string for the aggregate verifier name, and a SubVerifierDetails object

","parent_name":"SubverifierWrapper"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO3rpcyA2EmF":{"name":"rpc","abstract":"

RPC errors come directly from the Tezos RPC, but with the massive JSON object filtered down to the most meraningful part

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO6systemyA2EmF":{"name":"system","abstract":"

System errors are ones coming from the OS, e.g. “No internet connection”

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO7networkyAESicAEmF":{"name":"network(_:)","abstract":"

Network errors are returned by a server, such as HTTP 404’s and 500’s

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO19internalApplicationyA2EmF":{"name":"internalApplication","abstract":"

Internal application errors are errors from other services, components, libraiers etc, wrapped up so that they don’t require extra parsing

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO08decodingD0yA2EmF":{"name":"decodingError","abstract":"

For situations where the wrong model is returned. This can happen sometimes unexpectedily in GraphQL based APIs, instead of returning an error, it will just return a partial object missing non-optional fields

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO05knownD0yA2EmF":{"name":"knownError","abstract":"

For clients to catch known errors, sometimes handled in odd ways, enabling the easy return of a String. E.g. GraphQL throwing a malformed object response for a situation that should be a 404

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO7unknownyA2EmF":{"name":"unknown","abstract":"

Used as a fallback for strange edge cases where we can’t easily idenitfiy the issue

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html":{"name":"ErrorType","abstract":"

Categories of errors that are possible

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV9errorTypeAC0dF0Ovp":{"name":"errorType","abstract":"

The error category

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV05knownD7MessageSSSgvp":{"name":"knownErrorMessage","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV7subTypes0D0_pSgvp":{"name":"subType","abstract":"

Optional error subType coming from another source (the OS, URLSession, another library etc)

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV03rpcD6StringSSSgvp":{"name":"rpcErrorString","abstract":"

Optional string containing only the relvant portion of an RPC error (e.g instead of “proto.xxxxxxxx.gas_exhausted.operation”, it would contain “gas_exhausted.operation”) to make parsing easier

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV8failWithAA04FailF0VSgvp":{"name":"failWith","abstract":"

Optional object containing smart contract failure casues. May contain an Int (error code), a String (semi human readbale error message), and/or a dictionary containing metadata

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV10requestURL10Foundation0F0VSgvp":{"name":"requestURL","abstract":"

The requested URL that returned the error

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV11requestJSONSSSgvp":{"name":"requestJSON","abstract":"

The JSON that was sent as part of the request

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV12responseJSONSSSgvp":{"name":"responseJSON","abstract":"

The raw JSON that was returned

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV14httpStatusCodeSiSgvp":{"name":"httpStatusCode","abstract":"

The HTTP status code returned

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV03rpcD00eD6String11andFailWithACSS_AA0hI0VSgtFZ":{"name":"rpcError(rpcErrorString:andFailWith:)","abstract":"

Create a KukaiError from an RPC string (will not be validated). You can use the string extension .removeLeadingProtocolFromRPCError() to strip the leading poriton of the error

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV06systemD07subTypeACs0D0_p_tFZ":{"name":"systemError(subType:)","abstract":"

Create a KukaiError denoting a sytem issue from the OS, by passing in the system Error type

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV07networkD010statusCode10requestURLACSi_10Foundation0I0VtFZ":{"name":"networkError(statusCode:requestURL:)","abstract":"

Create a KukaiError denoting a network issue, by passing in the HTTP status code

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV019internalApplicationD05errorACs0D0_p_tFZ":{"name":"internalApplicationError(error:)","abstract":"

Create a KukaiError denoting an issue from some other component or library, by passing in the error that piece of code returned

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV08decodingD05errorACs0D0_p_tFZ":{"name":"decodingError(error:)","abstract":"

Create a KukaiError denoting an issue from some other component or library, by passing in the error that piece of code returned

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV05knownD7MessageyACSSFZ":{"name":"knownErrorMessage(_:)","abstract":"

Create a KukaiError allowing a client to simply provide the required error message.","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV7unknown10withStringACSSSg_tFZ":{"name":"unknown(withString:)","abstract":"

Create an unknown KukaiError

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV14addNetworkData10requestURL0H4JSON08responseJ014httpStatusCodey10Foundation0I0VSg_AI0G0VSgAOSiSgtF":{"name":"addNetworkData(requestURL:requestJSON:responseJSON:httpStatusCode:)","abstract":"

For network errors, attach all the necessary network data that may be needed in order to debug the issue, or log to a tool such as sentry

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV11descriptionSSvp":{"name":"description","abstract":"

Prints the underlying error type with either an RPC string, or an underlying Error object contents

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV05checkD12ForKnownCaseySSSgs0D0_pF":{"name":"checkErrorForKnownCase(_:)","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV27messageForNetworkStatusCode06statusI03urlSSSi_10Foundation3URLVtF":{"name":"messageForNetworkStatusCode(statusCode:url:)","parent_name":"KukaiError"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV11expectedXTZAA9XTZAmountCvp":{"name":"expectedXTZ","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV10minimumXTZAA9XTZAmountCvp":{"name":"minimumXTZ","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV13expectedTokenAA0I6AmountCvp":{"name":"expectedToken","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV12minimumTokenAA0I6AmountCvp":{"name":"minimumToken","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV12exchangeRateSo9NSDecimalavp":{"name":"exchangeRate","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV11expectedXTZ07minimumI00H5Token0jK012exchangeRateAcA9XTZAmountC_AjA0K6AmountCALSo9NSDecimalatcfc":{"name":"init(expectedXTZ:minimumXTZ:expectedToken:minimumToken:exchangeRate:)","parent_name":"DexRemoveCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV17expectedLiquidityAA11TokenAmountCvp":{"name":"expectedLiquidity","parent_name":"DexAddCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV16minimumLiquidityAA11TokenAmountCvp":{"name":"minimumLiquidity","parent_name":"DexAddCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV13tokenRequiredAA11TokenAmountCvp":{"name":"tokenRequired","parent_name":"DexAddCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV12exchangeRateSo9NSDecimalavp":{"name":"exchangeRate","parent_name":"DexAddCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV17expectedLiquidity07minimumI013tokenRequired12exchangeRateAcA11TokenAmountC_A2ISo9NSDecimalatcfc":{"name":"init(expectedLiquidity:minimumLiquidity:tokenRequired:exchangeRate:)","parent_name":"DexAddCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV8expectedAA11TokenAmountCvp":{"name":"expected","parent_name":"DexSwapCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV7minimumAA11TokenAmountCvp":{"name":"minimum","parent_name":"DexSwapCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV19displayExchangeRateSo9NSDecimalavp":{"name":"displayExchangeRate","parent_name":"DexSwapCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV18displayPriceImpactSdvp":{"name":"displayPriceImpact","parent_name":"DexSwapCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV8expected7minimum19displayExchangeRate0J11PriceImpactAcA11TokenAmountC_AISo9NSDecimalaSdtcfc":{"name":"init(expected:minimum:displayExchangeRate:displayPriceImpact:)","parent_name":"DexSwapCalculationResult"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV7addressSSvp":{"name":"address","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV02hdD9GroupNameSSSgvp":{"name":"hdWalletGroupName","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV14walletNicknameSSSgvp":{"name":"walletNickname","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV14socialUsernameSSSgvp":{"name":"socialUsername","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV14mainnetDomainsSayAA05TezosG13ReverseRecordVGSgvp":{"name":"mainnetDomains","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV15ghostnetDomainsSayAA05TezosG13ReverseRecordVGSgvp":{"name":"ghostnetDomains","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV10socialTypeAA17TorusAuthProviderOSgvp":{"name":"socialType","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV4typeAA0D4TypeOvp":{"name":"type","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV8childrenSayACGvp":{"name":"children","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV7isChildSbvp":{"name":"isChild","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV11isWatchOnlySbvp":{"name":"isWatchOnly","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV21bas58EncodedPublicKeySSvp":{"name":"bas58EncodedPublicKey","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV8backedUpSbvp":{"name":"backedUp","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV16hasMainnetDomainSbyF":{"name":"hasMainnetDomain()","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV17hasGhostnetDomainSbyF":{"name":"hasGhostnetDomain()","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV9hasDomain9onNetworkSbAA21TezosNodeClientConfigV0I4TypeO_tF":{"name":"hasDomain(onNetwork:)","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV20primaryMainnetDomainAA25TezosDomainsReverseRecordVSgyF":{"name":"primaryMainnetDomain()","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV21primaryGhostnetDomainAA25TezosDomainsReverseRecordVSgyF":{"name":"primaryGhostnetDomain()","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV13primaryDomain9onNetworkAA25TezosDomainsReverseRecordVSgAA0J16NodeClientConfigV0I4TypeO_tF":{"name":"primaryDomain(onNetwork:)","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV7address02hdD9GroupName14walletNickname14socialUsername14mainnetDomains08ghostnetO00L4Type4type8children7isChild0T9WatchOnly21bas58EncodedPublicKey8backedUpACSS_SSSgA2QSayAA05TezosO13ReverseRecordVGSgAuA17TorusAuthProviderOSgAA0dQ0OSayACGS2bSSSbtcfc":{"name":"init(address:hdWalletGroupName:walletNickname:socialUsername:mainnetDomains:ghostnetDomains:socialType:type:children:isChild:isWatchOnly:bas58EncodedPublicKey:backedUp:)","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"WalletMetadata"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV13socialWalletsSayAA0dE0VGvp":{"name":"socialWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV9hdWalletsSayAA0dE0VGvp":{"name":"hdWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV13linearWalletsSayAA0dE0VGvp":{"name":"linearWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV13ledgerWalletsSayAA0dE0VGvp":{"name":"ledgerWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV12watchWalletsSayAA0dE0VGvp":{"name":"watchWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV13socialWallets02hdH006linearH006ledgerH005watchH0ACSayAA0dE0VG_A4Ktcfc":{"name":"init(socialWallets:hdWallets:linearWallets:ledgerWallets:watchWallets:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV7isEmptySbyF":{"name":"isEmpty()","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV05firstE0AA0dE0VSgyF":{"name":"firstMetadata()","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV8metadata10forAddressAA0dE0VSgSS_tF":{"name":"metadata(forAddress:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV6update7address4withSbSS_AA0dE0VtF":{"name":"update(address:with:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV3set13mainnetDomain08ghostnetI010forAddressSbAA25TezosDomainsReverseRecordVSg_AJSStF":{"name":"set(mainnetDomain:ghostnetDomain:forAddress:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV3set8nickname10forAddressSbSSSg_SStF":{"name":"set(nickname:forAddress:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV3set02hdD9GroupName10forAddressSbSS_SStF":{"name":"set(hdWalletGroupName:forAddress:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV5countSiyF":{"name":"count()","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV9addressesSaySSGyF":{"name":"addresses()","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV03allE013onlySeedBasedSayAA0dE0VGSb_tF":{"name":"allMetadata(onlySeedBased:)","parent_name":"WalletMetadataList"},"Structs/SVGImgProcessor.html#/s:10Kingfisher14ImageProcessorP10identifierSSvp":{"name":"identifier","parent_name":"SVGImgProcessor"},"Structs/SVGImgProcessor.html#/s:10Kingfisher14ImageProcessorP7process4item7optionsSo7UIImageCSgAA0B11ProcessItemO_AA0A17ParsedOptionsInfoVtF":{"name":"process(item:options:)","parent_name":"SVGImgProcessor"},"Structs/FailWith.html#/s:14KukaiCoreSwift8FailWithV6stringSSSgvp":{"name":"string","parent_name":"FailWith"},"Structs/FailWith.html#/s:14KukaiCoreSwift8FailWithV3intSSSgvp":{"name":"int","parent_name":"FailWith"},"Structs/FailWith.html#/s:14KukaiCoreSwift8FailWithV4argsSaySDyS2SGGSgvp":{"name":"args","parent_name":"FailWith"},"Structs/FailWith.html#/s:14KukaiCoreSwift8FailWithV6string3int4argsACSSSg_AGSaySDyS2SGGSgtcfc":{"name":"init(string:int:args:)","parent_name":"FailWith"},"Structs/FailWith.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"FailWith"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV4kindSSvp":{"name":"kind","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV2idSSvp":{"name":"id","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV8contractSSSgvp":{"name":"contract","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV8expectedSSSgvp":{"name":"expected","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV5foundSSSgvp":{"name":"found","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV8locationSiSgvp":{"name":"location","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV4withAA8FailWithVSgvp":{"name":"with","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponse.html#/s:14KukaiCoreSwift17OperationResponseV8contentsSayAA0dE7ContentVGvp":{"name":"contents","parent_name":"OperationResponse"},"Structs/OperationResponse.html#/s:14KukaiCoreSwift17OperationResponseV8isFailedSbyF":{"name":"isFailed()","abstract":"

Check if the operation(s) have been backtracked or reversed due to a failure

","parent_name":"OperationResponse"},"Structs/OperationResponse.html#/s:14KukaiCoreSwift17OperationResponseV6errorsSayAA0dE19InternalResultErrorVGyF":{"name":"errors()","abstract":"

Return the last error object from each internal result. The last error object is the one that contains the location of the error in the smart contract and the with string, giving the most debugable information

","parent_name":"OperationResponse"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV6branchSSvp":{"name":"branch","abstract":"

The bracnh to use when sending

","parent_name":"OperationPayload"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV8contentsSayAA0D0CGvp":{"name":"contents","abstract":"

An array of Operation‘s to be sent together in 1 request.

","parent_name":"OperationPayload"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable

","parent_name":"OperationPayload"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV12addSignature_12signingCurveySays5UInt8VG_0a6CryptoC0010EllipticalI0OtF":{"name":"addSignature(_:signingCurve:)","abstract":"

Add the signature and the protocol to the operation so that it can be injected to the blockchain

","parent_name":"OperationPayload"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV10addProtcol12fromMetadatayAA0dI0V_tF":{"name":"addProtcol(fromMetadata:)","parent_name":"OperationPayload"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV10managerKeySSSgvp":{"name":"managerKey","abstract":"

The public key of the account managing the sender of this Operation

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV7counterSivp":{"name":"counter","abstract":"

The current counter used by this account on the network. All future Operation‘s need to be 1 higher

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV7chainIDSSvp":{"name":"chainID","abstract":"

The current Tezos network chainID to use for Operation‘s

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV6branchSSvp":{"name":"branch","abstract":"

The current branch used by the head block, used for estiamting and running preapply, to ensure the latest state information is available

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV8protocolSSvp":{"name":"protocol","abstract":"

The current Tezos network protocol to use for Operation‘s

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV10managerKey7counter14blockchainHeadACSSSg_SiAA010BlockchainJ0Vtcfc":{"name":"init(managerKey:counter:blockchainHead:)","abstract":"

Create an OperationMetadata

","parent_name":"OperationMetadata"},"Structs/OperationFees/NetworkFeeType.html#/s:14KukaiCoreSwift13OperationFeesV14NetworkFeeTypeO04burnG0yA2EmF":{"name":"burnFee","parent_name":"NetworkFeeType"},"Structs/OperationFees/NetworkFeeType.html#/s:14KukaiCoreSwift13OperationFeesV14NetworkFeeTypeO010allocationG0yA2EmF":{"name":"allocationFee","parent_name":"NetworkFeeType"},"Structs/OperationFees/NetworkFeeType.html":{"name":"NetworkFeeType","abstract":"

Enum to differentiate different types of extra fees. Such as allocation fees when sending to a currently unrevealed account.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV14transactionFeeAA9XTZAmountCvp":{"name":"transactionFee","abstract":"

The transaction fee that the sender is willing to pay in order to perform the Operation.","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV07networkE0SDyAC14NetworkFeeTypeOAA9XTZAmountCGvp":{"name":"networkFees","abstract":"

Additional fees the account will have to pay in order to send this operation. Such as allocating space for an unrevealed account.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV8gasLimitSivp":{"name":"gasLimit","abstract":"

The limit of gas (computation + CPU) this Operation should take. If it exceeds this value when running, the Operation will fail.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV12storageLimitSivp":{"name":"storageLimit","abstract":"

The limit of storage (disk) this Operation requires to complete. If it exceeds this value when running, the Operation will fail.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV03allE0AA9XTZAmountCyF":{"name":"allFees()","abstract":"

Add together all the network fees and transaction fees

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV010allNetworkE0AA9XTZAmountCyF":{"name":"allNetworkFees()","abstract":"

Add together all the network fees and transaction fees

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV4zeroACyFZ":{"name":"zero()","abstract":"

Creates an OperationFees object, with everything set to zero. Primarly used as a default / placeholder until an estimation can be performed

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV07defaultE013operationKindAcA0dH0O_tFZ":{"name":"defaultFees(operationKind:)","abstract":"

Get a default fees for each type of Operation. No guarentee these will succeed.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Confirming to Equatable

","parent_name":"OperationFees"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO5levelyA2EmF":{"name":"level","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO5protoyA2EmF":{"name":"proto","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO11predecessoryA2EmF":{"name":"predecessor","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO9timestampyA2EmF":{"name":"timestamp","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO14validationPassyA2EmF":{"name":"validationPass","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO14operationsHashyA2EmF":{"name":"operationsHash","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO7fitnessyA2EmF":{"name":"fitness","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO7contextyA2EmF":{"name":"context","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO8priorityyA2EmF":{"name":"priority","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO16proofOfWorkNonceyA2EmF":{"name":"proofOfWorkNonce","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO13seedNonceHashyA2EmF":{"name":"seedNonceHash","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO9signatureyA2EmF":{"name":"signature","parent_name":"CodingKeys"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV5levelSivp":{"name":"level","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV5protoSivp":{"name":"proto","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV11predecessorSSvp":{"name":"predecessor","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV9timestamp10Foundation4DateVvp":{"name":"timestamp","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV14validationPassSivp":{"name":"validationPass","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV14operationsHashSSvp":{"name":"operationsHash","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV7fitnessSaySSGvp":{"name":"fitness","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV7contextSSvp":{"name":"context","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV8prioritySivp":{"name":"priority","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV16proofOfWorkNonceSSvp":{"name":"proofOfWorkNonce","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV13seedNonceHashSSSgvp":{"name":"seedNonceHash","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV9signatureSSvp":{"name":"signature","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV5level5proto11predecessor9timestamp14validationPass14operationsHash7fitness7context8priority16proofOfWorkNonce04seeduN09signatureACSi_SiSS10Foundation4DateVSiSSSaySSGSSSiS2SSgSStcfc":{"name":"init(level:proto:predecessor:timestamp:validationPass:operationsHash:fitness:context:priority:proofOfWorkNonce:seedNonceHash:signature:)","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader/CodingKeys.html":{"name":"CodingKeys","parent_name":"OperationBlockHeader"},"Structs/NilOnDecodingError.html#/s:14KukaiCoreSwift18NilOnDecodingErrorV12wrappedValueACyxGxSg_tcfc":{"name":"init(wrappedValue:)","parent_name":"NilOnDecodingError"},"Structs/NilOnDecodingError.html#/s:14KukaiCoreSwift18NilOnDecodingErrorV12wrappedValuexSgvp":{"name":"wrappedValue","parent_name":"NilOnDecodingError"},"Structs/NilOnDecodingError.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"NilOnDecodingError"},"Structs/NilOnDecodingError.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"NilOnDecodingError"},"Structs/NetworkVersion.html#/s:14KukaiCoreSwift14NetworkVersionV17chainName_mainnetSSvpZ":{"name":"chainName_mainnet","parent_name":"NetworkVersion"},"Structs/NetworkVersion.html#/s:14KukaiCoreSwift14NetworkVersionV9chainNameSSyF":{"name":"chainName()","parent_name":"NetworkVersion"},"Structs/NetworkVersion.html#/s:14KukaiCoreSwift14NetworkVersionV9isMainnetSbyF":{"name":"isMainnet()","parent_name":"NetworkVersion"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV19minimal_block_delaySSvp":{"name":"minimal_block_delay","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV28hard_gas_limit_per_operationSSvp":{"name":"hard_gas_limit_per_operation","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV24hard_gas_limit_per_blockSSvp":{"name":"hard_gas_limit_per_block","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV16origination_sizeSivp":{"name":"origination_size","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV13cost_per_byteSSvp":{"name":"cost_per_byte","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV32hard_storage_limit_per_operationSSvp":{"name":"hard_storage_limit_per_operation","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV20secondsBetweenBlocksSiyF":{"name":"secondsBetweenBlocks()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV12mutezPerByteSiyF":{"name":"mutezPerByte()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV10xtzPerByteAA9XTZAmountCyF":{"name":"xtzPerByte()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV18maxGasPerOperationSiyF":{"name":"maxGasPerOperation()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV14maxGasPerBlockSiyF":{"name":"maxGasPerBlock()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV22maxStoragePerOperationSiyF":{"name":"maxStoragePerOperation()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV14bytesForRevealSiyF":{"name":"bytesForReveal()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV12xtzForRevealAA9XTZAmountCyF":{"name":"xtzForReveal()","parent_name":"NetworkConstants"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV7tokenIdSo9NSDecimalavp":{"name":"tokenId","abstract":"

Each NFT of a token has a unique ID

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11duplicateIDSiSgvp":{"name":"duplicateID","abstract":"

In order to display in a tablview, the element must be hashable. But in cases where you want to show duplciates (e.g. recents), the computed hash needs to be slightly different","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV14parentContractSSvp":{"name":"parentContract","abstract":"

The address of the FA2 contract that created this NFT

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11parentAliasSSSgvp":{"name":"parentAlias","abstract":"

The human readable alias of the parent contract (e.g. “Mooncakes”)

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV9faVersionAA02FaF0Ovp":{"name":"faVersion","abstract":"

The FaVersion of the token contrac

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"

Get the underlying number of decimal places that this token represents

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV7balanceSo9NSDecimalavp":{"name":"balance","abstract":"

Number of duplicate items of this NFT

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV4nameSSvp":{"name":"name","abstract":"

Human readbale name (e.g. “Tezos”)

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV6symbolSSSgvp":{"name":"symbol","abstract":"

Human readbale symbol (e.g. “XTZ”)

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11descriptionSSvp":{"name":"description","abstract":"

Human readable description (e.g. “This NFT was created too…”)

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11artifactURI10Foundation3URLVSgvp":{"name":"artifactURI","abstract":"

A URI to the asset the NFT is controlling ownership of

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV10displayURI10Foundation3URLVSgvp":{"name":"displayURI","abstract":"

A URI used to display media of the artifact

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV12thumbnailURI10Foundation3URLVSgvp":{"name":"thumbnailURI","abstract":"

A smaller thumbnail used to display meda of the artifact

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV8metadataAA19TzKTBalanceMetadataVSgvp":{"name":"metadata","abstract":"

Metadata object containing useful information about the nft and its contents

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV8isHiddenSbvp":{"name":"isHidden","abstract":"

Recording if the user has marked the token as hidden

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV18favouriteSortIndexSiSgvp":{"name":"favouriteSortIndex","abstract":"

Recording if the position the index the user chose for the favourite token to appear

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11isFavouriteSbvp":{"name":"isFavourite","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV15fromTzKTBalanceAcA0fG0V_tcfc":{"name":"init(fromTzKTBalance:)","abstract":"

Create a more developer friednly NFT from a generic TzKTBalance object

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Confomring to Equatable

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable

","parent_name":"NFT"},"Structs/NFT.html#/s:s12IdentifiableP2id2IDQzvp":{"name":"id","parent_name":"NFT"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV7xtzPoolAA9XTZAmountCvp":{"name":"xtzPool","abstract":"

The total amount of XTZ in the contract

","parent_name":"LiquidityBakingData"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV9tokenPoolAA11TokenAmountCvp":{"name":"tokenPool","abstract":"

The total amount of the token in the contract (currently tzBTC)

","parent_name":"LiquidityBakingData"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV05totalD0AA11TokenAmountCvp":{"name":"totalLiquidity","abstract":"

The total amount of liquidity tokens in circulation

","parent_name":"LiquidityBakingData"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV20tokenContractAddressSSvp":{"name":"tokenContractAddress","abstract":"

The address of the dex contract

","parent_name":"LiquidityBakingData"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV29liquidityTokenContractAddressSSvp":{"name":"liquidityTokenContractAddress","abstract":"

The address of the liquidty token contract

","parent_name":"LiquidityBakingData"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV2idSSvp":{"name":"id","abstract":"

Uniquie id of the domain

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV7addressSSvp":{"name":"address","abstract":"

The address that the domain points too

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV5ownerSSvp":{"name":"owner","abstract":"

The address that owns the domain

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV12expiresAtUtcSSSgvp":{"name":"expiresAtUtc","abstract":"

Expiration date

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV6domainAA0dE6DomainVvp":{"name":"domain","abstract":"

The domain object continaing the name and address

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV2id7address5owner12expiresAtUtc6domainACSS_S3SSgAA0dE6DomainVtcfc":{"name":"init(id:address:owner:expiresAtUtc:domain:)","abstract":"

Default init

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecords.html#/s:14KukaiCoreSwift26TezosDomainsReverseRecordsV5itemsACSayAA0deF6RecordVG_tcfc":{"name":"init(items:)","abstract":"

Default init

","parent_name":"TezosDomainsReverseRecords"},"Structs/TezosDomainsDomainBulkResponse.html#/s:14KukaiCoreSwift30TezosDomainsDomainBulkResponseV14reverseRecordsAA0de7ReverseJ0VSgvp":{"name":"reverseRecords","abstract":"

Object containing all the info of the record

","parent_name":"TezosDomainsDomainBulkResponse"},"Structs/TezosDomainsDomainBulkResponse.html#/s:14KukaiCoreSwift30TezosDomainsDomainBulkResponseV14reverseRecordsAcA0de7ReverseJ0VSg_tcfc":{"name":"init(reverseRecords:)","abstract":"

Default init

","parent_name":"TezosDomainsDomainBulkResponse"},"Structs/TezosDomainsDomainResponse.html#/s:14KukaiCoreSwift26TezosDomainsDomainResponseV13reverseRecordAA0de7ReverseI0VSgvp":{"name":"reverseRecord","abstract":"

Object containing all the info of the record

","parent_name":"TezosDomainsDomainResponse"},"Structs/TezosDomainsDomainResponse.html#/s:14KukaiCoreSwift26TezosDomainsDomainResponseV6domainSSSgyF":{"name":"domain()","abstract":"

Helper to extract the domain name more easily

","parent_name":"TezosDomainsDomainResponse"},"Structs/TezosDomainsDomainResponse.html#/s:14KukaiCoreSwift26TezosDomainsDomainResponseV13reverseRecordAcA0de7ReverseI0VSg_tcfc":{"name":"init(reverseRecord:)","abstract":"

Default init

","parent_name":"TezosDomainsDomainResponse"},"Structs/TezosDomainsDomain.html#/s:14KukaiCoreSwift18TezosDomainsDomainV4nameSSvp":{"name":"name","abstract":"

The domain name e.g. example.tez

","parent_name":"TezosDomainsDomain"},"Structs/TezosDomainsDomain.html#/s:14KukaiCoreSwift18TezosDomainsDomainV7addressSSvp":{"name":"address","abstract":"

The Tezos address that the domain points too

","parent_name":"TezosDomainsDomain"},"Structs/TezosDomainsDomain.html#/s:14KukaiCoreSwift18TezosDomainsDomainV4name7addressACSS_SStcfc":{"name":"init(name:address:)","abstract":"

Default init

","parent_name":"TezosDomainsDomain"},"Structs/TezosDomainsAddressResponse.html#/s:14KukaiCoreSwift27TezosDomainsAddressResponseV6domainAA0dE6DomainVvp":{"name":"domain","abstract":"

Domain object containing details about the domain

","parent_name":"TezosDomainsAddressResponse"},"Structs/TezosDomainsAddressResponse.html#/s:14KukaiCoreSwift27TezosDomainsAddressResponseV6domainAcA0dE6DomainV_tcfc":{"name":"init(domain:)","abstract":"

Default init

","parent_name":"TezosDomainsAddressResponse"},"Structs/TezosDomainsDomains.html#/s:14KukaiCoreSwift012TezosDomainsE0V5itemsACSayAA0dE6DomainVG_tcfc":{"name":"init(items:)","abstract":"

Default init

","parent_name":"TezosDomainsDomains"},"Structs/TezosDomainsAddressBulkResponse.html#/s:14KukaiCoreSwift31TezosDomainsAddressBulkResponseV7domainsAA0deE0VSgvp":{"name":"domains","abstract":"

Object containing all the info of the record

","parent_name":"TezosDomainsAddressBulkResponse"},"Structs/TezosDomainsAddressBulkResponse.html#/s:14KukaiCoreSwift31TezosDomainsAddressBulkResponseV7domainsAcA0deE0VSg_tcfc":{"name":"init(domains:)","abstract":"

Default init

","parent_name":"TezosDomainsAddressBulkResponse"},"Structs/ObjktFa.html#/s:14KukaiCoreSwift7ObjktFaV8editionsSo9NSDecimalaSgvp":{"name":"editions","parent_name":"ObjktFa"},"Structs/ObjktFa.html#/s:14KukaiCoreSwift7ObjktFaV11floor_priceSo9NSDecimalaSgvp":{"name":"floor_price","parent_name":"ObjktFa"},"Structs/ObjktEvent.html#/s:14KukaiCoreSwift10ObjktEventV9price_xtzSo9NSDecimalaSgvp":{"name":"price_xtz","parent_name":"ObjktEvent"},"Structs/ObjktListing.html#/s:14KukaiCoreSwift12ObjktListingV14seller_addressSSSgvp":{"name":"seller_address","parent_name":"ObjktListing"},"Structs/ObjktListing.html#/s:14KukaiCoreSwift12ObjktListingV9price_xtzSo9NSDecimalaSgvp":{"name":"price_xtz","parent_name":"ObjktListing"},"Structs/ObjktSale.html#/s:14KukaiCoreSwift9ObjktSaleV9price_xtzSo9NSDecimalaSgvp":{"name":"price_xtz","parent_name":"ObjktSale"},"Structs/ObjktSale.html#/s:14KukaiCoreSwift9ObjktSaleV9timestampSSSgvp":{"name":"timestamp","parent_name":"ObjktSale"},"Structs/ObjktAttributeCounts.html#/s:14KukaiCoreSwift20ObjktAttributeCountsV8editionsSo9NSDecimalavp":{"name":"editions","parent_name":"ObjktAttributeCounts"},"Structs/ObjktAttributeData.html#/s:14KukaiCoreSwift18ObjktAttributeDataV4nameSSvp":{"name":"name","parent_name":"ObjktAttributeData"},"Structs/ObjktAttributeData.html#/s:14KukaiCoreSwift18ObjktAttributeDataV5valueSSvp":{"name":"value","parent_name":"ObjktAttributeData"},"Structs/ObjktAttributeData.html#/s:14KukaiCoreSwift18ObjktAttributeDataV16attribute_countsSayAA0dE6CountsVGvp":{"name":"attribute_counts","parent_name":"ObjktAttributeData"},"Structs/ObjktAttribute.html#/s:14KukaiCoreSwift14ObjktAttributeV9attributeAA0dE4DataVvp":{"name":"attribute","parent_name":"ObjktAttribute"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV13highest_offerSo9NSDecimalaSgvp":{"name":"highest_offer","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV10lowest_askSo9NSDecimalaSgvp":{"name":"lowest_ask","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV8metadataSSSgvp":{"name":"metadata","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV4nameSSSgvp":{"name":"name","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV10attributesSayAA0D9AttributeVGvp":{"name":"attributes","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV13listing_salesSayAA0D4SaleVGvp":{"name":"listing_sales","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV15listings_activeSayAA0D7ListingVGvp":{"name":"listings_active","parent_name":"ObjktToken"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV5tokenSayAA0dE0VGvp":{"name":"token","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV5eventSayAA0D5EventVGvp":{"name":"event","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV2faSayAA0D2FaVGvp":{"name":"fa","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV8isOnSaleSbyF":{"name":"isOnSale()","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV11onSalePriceAA9XTZAmountCSgyF":{"name":"onSalePrice()","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV13lastSalePriceAA9XTZAmountCSgyF":{"name":"lastSalePrice()","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV10floorPriceAA9XTZAmountCSgyF":{"name":"floorPrice()","parent_name":"ObjktTokenReponse"},"Structs/ObjktCreator.html#/s:14KukaiCoreSwift12ObjktCreatorV7addressSSSgvp":{"name":"address","parent_name":"ObjktCreator"},"Structs/ObjktCreator.html#/s:14KukaiCoreSwift12ObjktCreatorV5aliasSSSgvp":{"name":"alias","parent_name":"ObjktCreator"},"Structs/ObjktCreator.html#/s:14KukaiCoreSwift12ObjktCreatorV7webisteSSSgvp":{"name":"webiste","parent_name":"ObjktCreator"},"Structs/ObjktCreator.html#/s:14KukaiCoreSwift12ObjktCreatorV7twitterSSSgvp":{"name":"twitter","parent_name":"ObjktCreator"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV8contractSSvp":{"name":"contract","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV4nameSSSgvp":{"name":"name","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV4logoSSSgvp":{"name":"logo","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV11floor_priceSo9NSDecimalaSgvp":{"name":"floor_price","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV7twitterSSSgvp":{"name":"twitter","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV7websiteSSSgvp":{"name":"website","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV6ownersSo9NSDecimalaSgvp":{"name":"owners","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV8editionsSo9NSDecimalaSgvp":{"name":"editions","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV7creatorAA0D7CreatorVSgvp":{"name":"creator","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV10websiteURL10Foundation0G0VSgyF":{"name":"websiteURL()","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV10twitterURL10Foundation0G0VSgyF":{"name":"twitterURL()","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV10floorPriceAA9XTZAmountCSgyF":{"name":"floorPrice()","parent_name":"ObjktCollection"},"Structs/ObjktCollections.html#/s:14KukaiCoreSwift16ObjktCollectionsV2faSayAA0D10CollectionVGvp":{"name":"fa","parent_name":"ObjktCollections"},"Structs/GraphQLResponse.html#/s:14KukaiCoreSwift15GraphQLResponseV6errorsSayAA0D7QLErrorVGSgvp":{"name":"errors","abstract":"

Array of errors returned from the server

","parent_name":"GraphQLResponse"},"Structs/GraphQLResponse.html#/s:14KukaiCoreSwift15GraphQLResponseV4dataxSgvp":{"name":"data","abstract":"

Generic data type matching the user supplied type

","parent_name":"GraphQLResponse"},"Structs/GraphQLError.html#/s:14KukaiCoreSwift12GraphQLErrorV7messageSSvp":{"name":"message","abstract":"

Message sent from the server explaining the issue

","parent_name":"GraphQLError"},"Structs/GraphQLError.html#/s:14KukaiCoreSwift12GraphQLErrorV9locationsSDyS2SGSgvp":{"name":"locations","abstract":"

Identifying the location fo the issue. E.g. codefile and line, or location of unexpected character/symbol in request string

","parent_name":"GraphQLError"},"Structs/GraphQLError.html#/s:14KukaiCoreSwift12GraphQLErrorV11extenstionsSDyS2SGSgvp":{"name":"extenstions","abstract":"

Not sure, but it shows up sometimes

","parent_name":"GraphQLError"},"Structs/FailWithParserLiquidityBaking.html#/s:14KukaiCoreSwift14FailWithParserP5parse04failE0SSSgAA0dE0VSg_tF":{"name":"parse(failWith:)","parent_name":"FailWithParserLiquidityBaking"},"Structs/QuipuswapExchangeUserRewards.html#/s:14KukaiCoreSwift28QuipuswapExchangeUserRewardsV6rewardSSvp":{"name":"reward","abstract":"

Total reward the user has earned

","parent_name":"QuipuswapExchangeUserRewards"},"Structs/QuipuswapExchangeUserRewards.html#/s:14KukaiCoreSwift28QuipuswapExchangeUserRewardsV11reward_paidSSvp":{"name":"reward_paid","abstract":"

Total rewards that have been paid out to the user

","parent_name":"QuipuswapExchangeUserRewards"},"Structs/QuipuswapExchangeUserRewardsKey.html#/s:14KukaiCoreSwift31QuipuswapExchangeUserRewardsKeyV5valueAA0defG0Vvp":{"name":"value","parent_name":"QuipuswapExchangeUserRewardsKey"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV6ledgerSivp":{"name":"ledger","abstract":"

Ledger bigmap id

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV12user_rewardsSivp":{"name":"user_rewards","abstract":"

user rewards bigmap id

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV6rewardSSvp":{"name":"reward","abstract":"

The current reward

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV11reward_paidSSvp":{"name":"reward_paid","abstract":"

The amount of rewards paid out

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV12total_rewardSSvp":{"name":"total_reward","abstract":"

Total reward

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV12total_supplySSvp":{"name":"total_supply","abstract":"

Totoal supply of this token

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV13period_finishSSvp":{"name":"period_finish","abstract":"

Date/Time the period will finish

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV14reward_per_secSSvp":{"name":"reward_per_sec","abstract":"

The reward per second

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV16last_update_timeSSvp":{"name":"last_update_time","abstract":"

Date/Time of the last recorded update to the sotrage

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV16reward_per_shareSSvp":{"name":"reward_per_share","abstract":"

The entitled reward per 1 share owned

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV4date4from10Foundation4DateVSgSS_tF":{"name":"date(from:)","abstract":"

Convert a string to a Date object using Zulu time format

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorageResponse.html#/s:14KukaiCoreSwift32QuipuswapExchangeStorageResponseV7storageAA0deF0Vvp":{"name":"storage","parent_name":"QuipuswapExchangeStorageResponse"},"Structs/QuipuswapExchangeLedger.html#/s:14KukaiCoreSwift23QuipuswapExchangeLedgerV7balanceSSvp":{"name":"balance","abstract":"

Usable balance of the token owned

","parent_name":"QuipuswapExchangeLedger"},"Structs/QuipuswapExchangeLedger.html#/s:14KukaiCoreSwift23QuipuswapExchangeLedgerV14frozen_balanceSSvp":{"name":"frozen_balance","abstract":"

Currently unaccessible balance of the token owned

","parent_name":"QuipuswapExchangeLedger"},"Structs/QuipuswapExchangeLedgerKey.html#/s:14KukaiCoreSwift26QuipuswapExchangeLedgerKeyV5valueAA0deF0Vvp":{"name":"value","parent_name":"QuipuswapExchangeLedgerKey"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV07primaryE3URL10Foundation0L0VvpZ":{"name":"primaryNodeURL","abstract":"

The default mainnet URL to use for primaryNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV05parseE3URL10Foundation0L0VvpZ":{"name":"parseNodeURL","abstract":"

The default testnet URL to use for parseNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV7tzktURL10Foundation0L0VvpZ":{"name":"tzktURL","abstract":"

The default testnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV16betterCallDevURL10Foundation0N0VvpZ":{"name":"betterCallDevURL","abstract":"

The default testnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV15tezosDomainsURL10Foundation0M0VvpZ":{"name":"tezosDomainsURL","abstract":"

The default testnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV11objktApiURL10Foundation0M0VvpZ":{"name":"objktApiURL","abstract":"

The default testnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV07primaryE3URL10Foundation0L0VvpZ":{"name":"primaryNodeURL","abstract":"

The default mainnet URL to use for primaryNodeURL, For more information on the free service, see: https://tezos.giganode.io/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV05parseE3URL10Foundation0L0VvpZ":{"name":"parseNodeURL","abstract":"

The default mainnet URL to use for parseNodeURL, For more information on the free service, see: https://nautilus.cloud/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV7tzktURL10Foundation0L0VvpZ":{"name":"tzktURL","abstract":"

The default mainnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV16betterCallDevURL10Foundation0N0VvpZ":{"name":"betterCallDevURL","abstract":"

The default mainnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV15tezosDomainsURL10Foundation0M0VvpZ":{"name":"tezosDomainsURL","abstract":"

The default mainnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV11objktApiURL10Foundation0M0VvpZ":{"name":"objktApiURL","abstract":"

The default mainnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/ForgingType.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11ForgingTypeO5localyA2EmF":{"name":"local","parent_name":"ForgingType"},"Structs/TezosNodeClientConfig/ForgingType.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11ForgingTypeO6remoteyA2EmF":{"name":"remote","parent_name":"ForgingType"},"Structs/TezosNodeClientConfig/NetworkType.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11NetworkTypeO7mainnetyA2EmF":{"name":"mainnet","parent_name":"NetworkType"},"Structs/TezosNodeClientConfig/NetworkType.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11NetworkTypeO7testnetyA2EmF":{"name":"testnet","parent_name":"NetworkType"},"Structs/TezosNodeClientConfig/NetworkType.html":{"name":"NetworkType","abstract":"

An enum indicating whether the network is mainnet or testnet

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig/ForgingType.html":{"name":"ForgingType","abstract":"

Allow switching between local forging or remote forging+parsing

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html":{"name":"defaultMainnetURLs","abstract":"

Preconfigured struct with all the URL’s needed to work with Tezos mainnet

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html":{"name":"defaultTestnetURLs","abstract":"

Preconfigured struct with all the URL’s needed to work with Tezos testnet

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV07primaryE3URL10Foundation0I0Vvp":{"name":"primaryNodeURL","abstract":"

The main URL used for remote forging, fetching balances, setting delegates and other forms of queries and operations.

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV05parseE3URL10Foundation0I0VSgvp":{"name":"parseNodeURL","abstract":"

When using remote forging, it is essential to use a second server to verify the contents of the remote forge match what the library sent.

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11forgingTypeAC07ForgingI0Ovp":{"name":"forgingType","abstract":"

Controls whether to use local forging or remote forging+parsing

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV7tzktURL10Foundation0I0Vvp":{"name":"tzktURL","abstract":"

The URL to use for TzKTClient

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV16betterCallDevURL10Foundation0K0Vvp":{"name":"betterCallDevURL","abstract":"

The URL to use for BetterCallDevClient

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV15tezosDomainsURL10Foundation0J0Vvp":{"name":"tezosDomainsURL","abstract":"

The URL to use for TezosDomainsClient

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11objktApiURL10Foundation0J0Vvp":{"name":"objktApiURL","abstract":"

The URL to use for TezosDomainsClient

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV10urlSessionSo12NSURLSessionCvp":{"name":"urlSession","abstract":"

The URLSession that will be used for all network communication. If looking to mock this library, users should create their own URLSessionMock and pass it in.

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11networkTypeAC07NetworkI0Ovp":{"name":"networkType","abstract":"

The network type of the connected node

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV07loggingG0AA07LoggingG0Vvp":{"name":"loggingConfig","abstract":"

Control what gets logged to the console

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV26withDefaultsForNetworkTypeA2C0kL0O_tcfc":{"name":"init(withDefaultsForNetworkType:)","abstract":"

Init a TezosNodeClientConfig with the defaults

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV20configWithLocalForge07primaryE3URL04tzktM0013betterCallDevM0012tezosDomainsM008objktApiM010urlSession11networkTypeAC10Foundation0M0V_A4NSo12NSURLSessionCAC07NetworkY0OtFZ":{"name":"configWithLocalForge(primaryNodeURL:tzktURL:betterCallDevURL:tezosDomainsURL:objktApiURL:urlSession:networkType:)","abstract":"

Creates an instance of TezosNodeClientConfig with only the required properties needed when using local forge.

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV21configWithRemoteForge07primaryE3URL05parseeM004tzktM0013betterCallDevM0012tezosDomainsM008objktApiM010urlSession11networkTypeAC10Foundation0M0V_A5OSo12NSURLSessionCAC07NetworkZ0OtFZ":{"name":"configWithRemoteForge(primaryNodeURL:parseNodeURL:tzktURL:betterCallDevURL:tezosDomainsURL:objktApiURL:urlSession:networkType:)","abstract":"

Creates an instance of TezosNodeClientConfig with the required properties for remote forging. Note: function will casue a fatalError is users attempt to set primaryNodeURL and parseNodeURL to the same destination

","parent_name":"TezosNodeClientConfig"},"Structs/LoggingConfig.html#/s:14KukaiCoreSwift13LoggingConfigV6allOffyyF":{"name":"allOff()","abstract":"

Turn off all logging

","parent_name":"LoggingConfig"},"Structs/LoggingConfig.html#/s:14KukaiCoreSwift13LoggingConfigV5allOnyyF":{"name":"allOn()","parent_name":"LoggingConfig"},"Structs/BlockchainHead.html#/s:14KukaiCoreSwift14BlockchainHeadV8protocolSSvp":{"name":"protocol","abstract":"

The current protocol version string

","parent_name":"BlockchainHead"},"Structs/BlockchainHead.html#/s:14KukaiCoreSwift14BlockchainHeadV7chainIDSSvp":{"name":"chainID","abstract":"

The current chainID being used

","parent_name":"BlockchainHead"},"Structs/BlockchainHead.html#/s:14KukaiCoreSwift14BlockchainHeadV4hashSSvp":{"name":"hash","abstract":"

The current hash or branch being used

","parent_name":"BlockchainHead"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV9groupTypeAA0dE0V014TransactionSubH0Ovp":{"name":"groupType","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV4hashSSvp":{"name":"hash","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV12transactionsSayAA0dE0VGvp":{"name":"transactions","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV6statusAA0dE0V17TransactionStatusOvp":{"name":"status","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV12primaryTokenAA0H0CSgvp":{"name":"primaryToken","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV14secondaryTokenAA0H0CSgvp":{"name":"secondaryToken","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV16entrypointCalledSSSgvp":{"name":"entrypointCalled","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:s12IdentifiableP2id2IDQzvp":{"name":"id","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV16withTransactions20currentWalletAddressACSgSayAA0dE0VG_SStcfc":{"name":"init(withTransactions:currentWalletAddress:)","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO4typeyA2EmF":{"name":"type","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO2idyA2EmF":{"name":"id","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO5levelyA2EmF":{"name":"level","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO9timestampyA2EmF":{"name":"timestamp","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO4hashyA2EmF":{"name":"hash","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO7counteryA2EmF":{"name":"counter","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO9initiateryA2EmF":{"name":"initiater","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6senderyA2EmF":{"name":"sender","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO8bakerFeeyA2EmF":{"name":"bakerFee","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO10storageFeeyA2EmF":{"name":"storageFee","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO13allocationFeeyA2EmF":{"name":"allocationFee","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6targetyA2EmF":{"name":"target","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO12prevDelegateyA2EmF":{"name":"prevDelegate","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO11newDelegateyA2EmF":{"name":"newDelegate","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6amountyA2EmF":{"name":"amount","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO9parameteryA2EmF":{"name":"parameter","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6statusyA2EmF":{"name":"status","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO7subTypeyA2EmF":{"name":"subType","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO16entrypointCalledyA2EmF":{"name":"entrypointCalled","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO12primaryTokenyA2EmF":{"name":"primaryToken","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO12hasInternalsyA2EmF":{"name":"hasInternals","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO19tokenTransfersCountyA2EmF":{"name":"tokenTransfersCount","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6errorsyA2EmF":{"name":"errors","parent_name":"CodingKeys"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO4sendyA2EmF":{"name":"send","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO7receiveyA2EmF":{"name":"receive","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO8delegateyA2EmF":{"name":"delegate","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO6revealyA2EmF":{"name":"reveal","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO8exchangeyA2EmF":{"name":"exchange","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO12contractCallyA2EmF":{"name":"contractCall","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO7unknownyA2EmF":{"name":"unknown","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO10delegationyA2EmF":{"name":"delegation","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO11originationyA2EmF":{"name":"origination","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO11transactionyA2EmF":{"name":"transaction","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO6revealyA2EmF":{"name":"reveal","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO7unknownyA2EmF":{"name":"unknown","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO7appliedyA2EmF":{"name":"applied","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO6failedyA2EmF":{"name":"failed","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO11backtrackedyA2EmF":{"name":"backtracked","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO11unconfirmedyA2EmF":{"name":"unconfirmed","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO18partiallyConfirmedyA2EmF":{"name":"partiallyConfirmed","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO9confirmedyA2EmF":{"name":"confirmed","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO7unknownyA2EmF":{"name":"unknown","parent_name":"TransactionStatus"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV13dateFormatterSo06NSDateG0CvpZ":{"name":"dateFormatter","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction/TransactionStatus.html":{"name":"TransactionStatus","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction/TransactionType.html":{"name":"TransactionType","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction/TransactionSubType.html":{"name":"TransactionSubType","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV16TransactionErrorV":{"name":"TransactionError","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4typeAC15TransactionTypeOvp":{"name":"type","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:s12IdentifiableP2id2IDQzvp":{"name":"id","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV5levelSo9NSDecimalavp":{"name":"level","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV9timestampSSvp":{"name":"timestamp","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4hashSSvp":{"name":"hash","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV7counterSo9NSDecimalavp":{"name":"counter","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV9initiaterAA0D9KTAddressVSgvp":{"name":"initiater","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6senderAA0D9KTAddressVvp":{"name":"sender","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV8bakerFeeAA9XTZAmountCvp":{"name":"bakerFee","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV10storageFeeAA9XTZAmountCvp":{"name":"storageFee","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV13allocationFeeAA9XTZAmountCvp":{"name":"allocationFee","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6targetAA0D9KTAddressVSgvp":{"name":"target","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV12prevDelegateAA0D9KTAddressVSgvp":{"name":"prevDelegate","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV11newDelegateAA0D9KTAddressVSgvp":{"name":"newDelegate","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6amountAA11TokenAmountCvp":{"name":"amount","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV9parameterSDyS2SGSgvp":{"name":"parameter","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6statusAC17TransactionStatusOvp":{"name":"status","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV12hasInternalsSbvp":{"name":"hasInternals","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV19tokenTransfersCountSo9NSDecimalaSgvp":{"name":"tokenTransfersCount","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6errorsSayAC16TransactionErrorVGSgvp":{"name":"errors","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4date10Foundation4DateVSgvp":{"name":"date","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV17tzktTokenTransferAA0d7KTTokenH0VSgvp":{"name":"tzktTokenTransfer","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV7subTypeAC014TransactionSubG0OSgvp":{"name":"subType","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV16entrypointCalledSSSgvp":{"name":"entrypointCalled","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV12primaryTokenAA0G0CSgvp":{"name":"primaryToken","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction/CodingKeys.html":{"name":"CodingKeys","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4type2id5level9timestamp4hash7counter9initiater6sender8bakerFee07storageO0010allocationO06target12prevDelegate03newT06amount9parameter6status12hasInternals19tokenTransfersCount6errorsA2C15TransactionTypeO_So9NSDecimalaA_S2SA_AA0D9KTAddressVSgA1_AA9XTZAmountCA4_A4_A2_A2_A2_AA11TokenAmountCSDyS2SGSgAC17TransactionStatusOSbA_SgSayAC16TransactionErrorVGSgtcfc":{"name":"init(type:id:level:timestamp:hash:counter:initiater:sender:bakerFee:storageFee:allocationFee:target:prevDelegate:newDelegate:amount:parameter:status:hasInternals:tokenTransfersCount:errors:)","abstract":"

Manually init a TzKTTransaction

","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4fromAcA0D15KTTokenTransferV_tcfc":{"name":"init(from:)","abstract":"

Convert a TzKTTokenTransfer into a TzKTTransaction

","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV11placeholder10withStatus6opHash4type7counter10fromWallet11destination9xtzAmount10parameters12primaryTokenA2C011TransactionH0O_SSAC0U4TypeOSo9NSDecimalaAA0N8MetadataVAA0D9KTAddressVAA0tQ0CSDyS2SGSgAA0T0CSgtFZ":{"name":"placeholder(withStatus:opHash:type:counter:fromWallet:destination:xtzAmount:parameters:primaryToken:)","abstract":"

Used for creating “Pending” transactions

","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV11placeholder10withStatus6opHash4type7counter10fromWallet11newDelegateA2C011TransactionH0O_SSAC0Q4TypeOSo9NSDecimalaAA0N8MetadataVAA0D9KTAddressVSgtFZ":{"name":"placeholder(withStatus:opHash:type:counter:fromWallet:newDelegate:)","abstract":"

Used for createing a “Pending” delegation transaction

","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV21parameterValueAsArraySayypGSgyF":{"name":"parameterValueAsArray()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV20parameterValueAsDictSDySSypGSgyF":{"name":"parameterValueAsDict()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV33parameterValueAsArrayOfDictionarySaySDySSypGGSgyF":{"name":"parameterValueAsArrayOfDictionary()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV20parameterValueAsType4typexSgxm_tlF":{"name":"parameterValueAsType(type:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV13getEntrypointSSSgyF":{"name":"getEntrypoint()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV21processAdditionalData24withCurrentWalletAddressySS_tF":{"name":"processAdditionalData(withCurrentWalletAddress:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV18createPrimaryTokenAA0H0CSgyF":{"name":"createPrimaryToken()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV22getFaTokenTransferDataAA0H0CSgyF":{"name":"getFaTokenTransferData()","abstract":"

The TzKT transaction API doesn’t provide all the info needed to normalise Token amounts. It only gives address and rpc amount.","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV27getTokenTransferDestinationSSSgyF":{"name":"getTokenTransferDestination()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV11errorStringSSSgyF":{"name":"errorString()","parent_name":"TzKTTransaction"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV2idSo9NSDecimalavp":{"name":"id","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV4hashSSSgvp":{"name":"hash","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV5levelSo9NSDecimalavp":{"name":"level","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV9timestampSSvp":{"name":"timestamp","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV5tokenAA0D14KTBalanceTokenVvp":{"name":"token","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV2toAA0D9KTAddressVSgvp":{"name":"to","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV4fromAA0D9KTAddressVSgvp":{"name":"from","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV6amountSSvp":{"name":"amount","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV13transactionIdSo9NSDecimalavp":{"name":"transactionId","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV11mintingToolSSSgvp":{"name":"mintingTool","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV11tokenAmountAA05TokenH0CyF":{"name":"tokenAmount()","parent_name":"TzKTTokenTransfer"},"Structs/TzKTOperationError.html#/s:14KukaiCoreSwift18TzKTOperationErrorV4typeSSvp":{"name":"type","abstract":"

The RPC error type string

","parent_name":"TzKTOperationError"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV4typeSSvp":{"name":"type","abstract":"

Type of operation (e.g. transaction, delegation, reveal etc)

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV2idSivp":{"name":"id","abstract":"

Unique id to denote the operation

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV5levelSivp":{"name":"level","abstract":"

The block level it was injected at

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV9timestampSSvp":{"name":"timestamp","abstract":"

Timestamp it was injected at

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV5blockSSvp":{"name":"block","abstract":"

The hash of the injected block

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV4hashSSvp":{"name":"hash","abstract":"

The operation hash

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV7counterSivp":{"name":"counter","abstract":"

The users numerical counter of the operation

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV6statusSSvp":{"name":"status","abstract":"

Status of the operation (e.g. applied or failed)

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV6errorsSayAA0dE5ErrorVGSgvp":{"name":"errors","abstract":"

Optional array of errors encountered while trying to inject the operation

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV8isFailedSbyF":{"name":"isFailed()","abstract":"

Helper to detect a failed transation by searching for a status of “failed”, “backtracked” or “skipped”

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV13containsErrorSbyF":{"name":"containsError()","abstract":"

Helper to detect if this operation contains an error

","parent_name":"TzKTOperation"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV5cycleSivp":{"name":"cycle","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV7balanceSo9NSDecimalavp":{"name":"balance","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV5bakerAA0D9KTAddressVvp":{"name":"baker","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV14stakingBalanceSo9NSDecimalavp":{"name":"stakingBalance","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV12blockRewardsSo9NSDecimalavp":{"name":"blockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV18missedBlockRewardsSo9NSDecimalavp":{"name":"missedBlockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV18endorsementRewardsSo9NSDecimalavp":{"name":"endorsementRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV24missedEndorsementRewardsSo9NSDecimalavp":{"name":"missedEndorsementRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV9blockFeesSo9NSDecimalavp":{"name":"blockFees","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV15missedBlockFeesSo9NSDecimalavp":{"name":"missedBlockFees","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV17extraBlockRewardsSo9NSDecimalavp":{"name":"extraBlockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV23missedExtraBlockRewardsSo9NSDecimalavp":{"name":"missedExtraBlockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV18futureBlockRewardsSo9NSDecimalavp":{"name":"futureBlockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV24futureEndorsementRewardsSo9NSDecimalavp":{"name":"futureEndorsementRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV09estimatedF07withFee03andF6StructAA9XTZAmountCSd_AA0d13KTBakerConfigfK0VSgtF":{"name":"estimatedReward(withFee:andRewardStruct:)","abstract":"

Return an estimated either for potential future or actual rewards

","parent_name":"TzKTDelegatorReward"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV9startTimeSSvp":{"name":"startTime","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV10firstLevelSo9NSDecimalavp":{"name":"firstLevel","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV7endTimeSSvp":{"name":"endTime","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV9lastLevelSo9NSDecimalavp":{"name":"lastLevel","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV9stateDate10Foundation0G0VSgvp":{"name":"stateDate","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV7endDate10Foundation0G0VSgvp":{"name":"endDate","parent_name":"TzKTCycle"},"Structs/TzKTBalanceMetadataDimensions.html#/s:14KukaiCoreSwift29TzKTBalanceMetadataDimensionsV4unitSSSgvp":{"name":"unit","abstract":"

The unit of measurement (e.g. px for pixels)

","parent_name":"TzKTBalanceMetadataDimensions"},"Structs/TzKTBalanceMetadataDimensions.html#/s:14KukaiCoreSwift29TzKTBalanceMetadataDimensionsV5valueSSSgvp":{"name":"value","abstract":"

String containing the resolution or size (e.g. 1024x787)

","parent_name":"TzKTBalanceMetadataDimensions"},"Structs/TzKTBalanceMetadataDimensions.html#/s:14KukaiCoreSwift29TzKTBalanceMetadataDimensionsV4unit5valueACSS_SStcfc":{"name":"init(unit:value:)","abstract":"

Init to manaually create an instance, mostly for testing

","parent_name":"TzKTBalanceMetadataDimensions"},"Structs/TzKTBalanceMetadataFormat.html#/s:14KukaiCoreSwift25TzKTBalanceMetadataFormatV3uriSSvp":{"name":"uri","abstract":"

The URI to this specific format

","parent_name":"TzKTBalanceMetadataFormat"},"Structs/TzKTBalanceMetadataFormat.html#/s:14KukaiCoreSwift25TzKTBalanceMetadataFormatV8mimeTypeSSvp":{"name":"mimeType","abstract":"

The mimetype of this version

","parent_name":"TzKTBalanceMetadataFormat"},"Structs/TzKTBalanceMetadataFormat.html#/s:14KukaiCoreSwift25TzKTBalanceMetadataFormatV10dimensionsAA0deF10DimensionsVSgvp":{"name":"dimensions","abstract":"

The display dimensions

","parent_name":"TzKTBalanceMetadataFormat"},"Structs/TzKTBalanceMetadataFormat.html#/s:14KukaiCoreSwift25TzKTBalanceMetadataFormatV3uri8mimeType10dimensionsACSS_SSAA0deF10DimensionsVSgtcfc":{"name":"init(uri:mimeType:dimensions:)","abstract":"

Init to manaually create an instance, mostly for testing

","parent_name":"TzKTBalanceMetadataFormat"},"Structs/TzKTBalanceMetadataAttributeKeyValue.html#/s:14KukaiCoreSwift36TzKTBalanceMetadataAttributeKeyValueV3keySSvp":{"name":"key","parent_name":"TzKTBalanceMetadataAttributeKeyValue"},"Structs/TzKTBalanceMetadataAttributeKeyValue.html#/s:14KukaiCoreSwift36TzKTBalanceMetadataAttributeKeyValueV5valueSSvp":{"name":"value","parent_name":"TzKTBalanceMetadataAttributeKeyValue"},"Structs/TzKTBalanceMetadataAttributeKeyValue.html#/s:14KukaiCoreSwift36TzKTBalanceMetadataAttributeKeyValueV3key5valueACSS_SStcfc":{"name":"init(key:value:)","parent_name":"TzKTBalanceMetadataAttributeKeyValue"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV4nameSSSgvp":{"name":"name","abstract":"

A human readbale name

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV6symbolSSSgvp":{"name":"symbol","abstract":"

The tokens symbol

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV8decimalsSSvp":{"name":"decimals","abstract":"

The number of decimals the token has

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV11decimalsIntSivp":{"name":"decimalsInt","abstract":"

Helper to convert the decimals to an Int

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV7formatsSayAA0deF6FormatVGSgvp":{"name":"formats","abstract":"

Details of the available formats that the media is available in

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV10displayUriSSSgvp":{"name":"displayUri","abstract":"

URI to an medium/large image owned by the contract

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV11artifactUriSSSgvp":{"name":"artifactUri","abstract":"

URI to the raw media artifact owned by the token

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV12thumbnailUriSSSgvp":{"name":"thumbnailUri","abstract":"

URI to an small image for the token, ususally used as an icon when displayed in lists

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV11descriptionSSSgvp":{"name":"description","abstract":"

Description of the token or NFT

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV11mintingToolSSSgvp":{"name":"mintingTool","abstract":"

URL to the tool that was used to mint the item

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV4tagsSaySSGSgvp":{"name":"tags","abstract":"

A list of tags to categorize the token / NFT

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV6minterSSSgvp":{"name":"minter","abstract":"

The address responsible for creating the token / NFT

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV18shouldPreferSymbolSbSgvp":{"name":"shouldPreferSymbol","abstract":"

Whether or not the symbol or the name is prefered when displaying the token / NFT in a list

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV10attributesSayypGSgvp":{"name":"attributes","abstract":"

A collection of attributes about the token/NFT. Although TZIP-16 intended for this to be filled with info such as license, version, possible error messages etc,","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV3ttlSiSgvp":{"name":"ttl","abstract":"

Flag, in seconds, indicating how long to wait before refreshing the token to update its metadata. E.g. fxHash will inject a token with a name “[Waiting to be Signed]”. and then, all things going well, 30 seconds later its updated to the correct attributes

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV4name6symbol8decimals7formats10displayUri08artifactL009thumbnailL011description11mintingTool4tags6minter18shouldPreferSymbol10attributes3ttlACSSSg_ARSSSayAA0deF6FormatVGSgA5RSaySSGSgARSbSgSayypGSgSiSgtcfc":{"name":"init(name:symbol:decimals:formats:displayUri:artifactUri:thumbnailUri:description:mintingTool:tags:minter:shouldPreferSymbol:attributes:ttl:)","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV12thumbnailURL10Foundation0H0VSgvp":{"name":"thumbnailURL","abstract":"

Helper to run the URI through the MediaProxyService to generate a useable URL for the thumbnail (if available)

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV10displayURL10Foundation0H0VSgvp":{"name":"displayURL","abstract":"

Helper to run the URI through the MediaProxyService to generate a useable URL for the display image (if available)

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV26getKeyValuesFromAttributesSayAA0def9AttributeH5ValueVGyF":{"name":"getKeyValuesFromAttributes()","abstract":"

Attributes is a complex free-form object. In a lot of cases when NFT’s are games / collectibles, it should be possible to convert most if not all the elements into more simple String: String key value pairs, which will be easier to manage in table / collection views

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV8contractAA0D9KTAddressVvp":{"name":"contract","abstract":"

Details of the contract (e.g. address)

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV7tokenIdSSvp":{"name":"tokenId","abstract":"

The FA2 token ID of the token

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV8standardAA9FaVersionOvp":{"name":"standard","abstract":"

Which FA version the token conforms too

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV11totalSupplySSSgvp":{"name":"totalSupply","abstract":"

Total avaialble supply of this address + token id combo

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV8metadataAA0dE8MetadataVSgvp":{"name":"metadata","abstract":"

Metadata about the token

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV17malformedMetadataSbvp":{"name":"malformedMetadata","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV13displaySymbolSSvp":{"name":"displaySymbol","abstract":"

Helper to determine what string is used as the symbol for display purposes

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV8contract7tokenId8standard11totalSupply8metadataAcA0D9KTAddressV_SSAA9FaVersionOSSSgAA0dE8MetadataVSgtcfc":{"name":"init(contract:tokenId:standard:totalSupply:metadata:)","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV16exceptionListNFTSaySSGvpZ":{"name":"exceptionListNFT","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV7balanceSSvp":{"name":"balance","abstract":"

String containing the RPC respresetnation of the balance of the given token

","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV5tokenAA0dE5TokenVvp":{"name":"token","abstract":"

Details about the Token

","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV11tokenAmountAA05TokenG0Cvp":{"name":"tokenAmount","abstract":"

Helper to convert the RPC token balance to a TokenAmount object

","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV5isNFTSbyF":{"name":"isNFT()","abstract":"

Basic check to see if token is an NFT or not. May not be 100% successful, needs research

","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV20isOnNFTExceptionListSbyF":{"name":"isOnNFTExceptionList()","parent_name":"TzKTBalance"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV6blocksSbvp":{"name":"blocks","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV12missedBlocksSbvp":{"name":"missedBlocks","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV12endorsementsSbvp":{"name":"endorsements","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV18missedEndorsementsSbvp":{"name":"missedEndorsements","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV4feesSbvp":{"name":"fees","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV10missedFeesSbvp":{"name":"missedFees","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV17accusationRewardsSbvp":{"name":"accusationRewards","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV16accusationLossesSbvp":{"name":"accusationLosses","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV17revelationRewardsSbvp":{"name":"revelationRewards","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV16revelationLossesSbvp":{"name":"revelationLosses","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV04fromF3IntyACSiFZ":{"name":"fromConfigInt(_:)","abstract":"

Convert the 14-bit number in the baker config, to the equivalent set of flags

","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigIntValue.html#/s:14KukaiCoreSwift23TzKTBakerConfigIntValueV5cycleSivp":{"name":"cycle","parent_name":"TzKTBakerConfigIntValue"},"Structs/TzKTBakerConfigIntValue.html#/s:14KukaiCoreSwift23TzKTBakerConfigIntValueV5valueSivp":{"name":"value","parent_name":"TzKTBakerConfigIntValue"},"Structs/TzKTBakerConfigDoubleValue.html#/s:14KukaiCoreSwift26TzKTBakerConfigDoubleValueV5cycleSivp":{"name":"cycle","parent_name":"TzKTBakerConfigDoubleValue"},"Structs/TzKTBakerConfigDoubleValue.html#/s:14KukaiCoreSwift26TzKTBakerConfigDoubleValueV5valueSdvp":{"name":"value","parent_name":"TzKTBakerConfigDoubleValue"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV7addressSSvp":{"name":"address","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV3feeSayAA0deF11DoubleValueVGvp":{"name":"fee","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV13minDelegationSayAA0deF11DoubleValueVGvp":{"name":"minDelegation","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV11payoutDelaySayAA0deF8IntValueVGvp":{"name":"payoutDelay","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV12rewardStructSayAA0deF8IntValueVGvp":{"name":"rewardStruct","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV10latesetFeeSdyF":{"name":"latesetFee()","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV11feeForCycle5cycleSdSi_tF":{"name":"feeForCycle(cycle:)","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV17latestPayoutDelaySiyF":{"name":"latestPayoutDelay()","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV19payoutDelayForCycle5cycleS2i_tF":{"name":"payoutDelayForCycle(cycle:)","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV18latestRewardStructSiSgyF":{"name":"latestRewardStruct()","parent_name":"TzKTBakerConfig"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV7addressSSvp":{"name":"address","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV4nameSSSgvp":{"name":"name","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV4logoSSSgvp":{"name":"logo","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV7balanceSo9NSDecimalavp":{"name":"balance","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV14stakingBalanceSo9NSDecimalavp":{"name":"stakingBalance","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV15stakingCapacitySo9NSDecimalavp":{"name":"stakingCapacity","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV17maxStakingBalanceSo9NSDecimalavp":{"name":"maxStakingBalance","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV9freeSpaceSo9NSDecimalavp":{"name":"freeSpace","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV3feeSdvp":{"name":"fee","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV13minDelegationSo9NSDecimalavp":{"name":"minDelegation","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV11payoutDelaySivp":{"name":"payoutDelay","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV12payoutPeriodSivp":{"name":"payoutPeriod","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV17openForDelegationSbvp":{"name":"openForDelegation","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV12estimatedRoiSo9NSDecimalavp":{"name":"estimatedRoi","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV13serviceHealthAA0deG0Ovp":{"name":"serviceHealth","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV12payoutTimingAA0deG0Ovp":{"name":"payoutTiming","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV14payoutAccuracyAA0deG0Ovp":{"name":"payoutAccuracy","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV6configAA0dE6ConfigVSgvp":{"name":"config","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV7address4name4logoACSS_SSSgAGtcfc":{"name":"init(address:name:logo:)","abstract":"

Helper to create a TzKTBaker from the data available from the Account object

","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV7address4name4logo7balance14stakingBalance0J8Capacity010maxStakingK09freeSpace3fee13minDelegation11payoutDelay0T6Period07openForS012estimatedRoi13serviceHealth0T6Timing0T8Accuracy6configACSS_SSSgAVSo9NSDecimalaA4XSdAXS2iSbAxA0dE6HealthOAA0dE6TimingOAA0dE8AccuracyOAA0dE6ConfigVSgtcfc":{"name":"init(address:name:logo:balance:stakingBalance:stakingCapacity:maxStakingBalance:freeSpace:fee:minDelegation:payoutDelay:payoutPeriod:openForDelegation:estimatedRoi:serviceHealth:payoutTiming:payoutAccuracy:config:)","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV16fromTestnetArrayyACSgSayypGFZ":{"name":"fromTestnetArray(_:)","abstract":"

Ghostnet has a different setup for bakers, but we need to display and interact with them the same way.","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV12rewardStructAA0de12ConfigRewardG0VSgyF":{"name":"rewardStruct()","abstract":"

Convert con-chain data into a meaningful, readable object

","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"TzKTBaker"},"Structs/TzKTAddress.html#/s:14KukaiCoreSwift11TzKTAddressV5aliasSSSgvp":{"name":"alias","abstract":"

Contract addresses may have an alias (human readbale) name, to denote a person or service

","parent_name":"TzKTAddress"},"Structs/TzKTAddress.html#/s:14KukaiCoreSwift11TzKTAddressV7addressSSvp":{"name":"address","abstract":"

The KT1 address of the contract

","parent_name":"TzKTAddress"},"Structs/TzKTAddress.html#/s:14KukaiCoreSwift11TzKTAddressV5alias7addressACSSSg_SStcfc":{"name":"init(alias:address:)","parent_name":"TzKTAddress"},"Structs/TzKTAccountDelegate.html#/s:14KukaiCoreSwift19TzKTAccountDelegateV5aliasSSSgvp":{"name":"alias","abstract":"

Bakers may have an alias (human readbale) name for their service

","parent_name":"TzKTAccountDelegate"},"Structs/TzKTAccountDelegate.html#/s:14KukaiCoreSwift19TzKTAccountDelegateV7addressSSvp":{"name":"address","abstract":"

Bakers must have a valid address

","parent_name":"TzKTAccountDelegate"},"Structs/TzKTAccountDelegate.html#/s:14KukaiCoreSwift19TzKTAccountDelegateV6activeSbvp":{"name":"active","abstract":"

Bool indicating whether or not the baker is currently active

","parent_name":"TzKTAccountDelegate"},"Structs/TzKTAccountDelegate.html#/s:14KukaiCoreSwift19TzKTAccountDelegateV5alias7address6activeACSSSg_SSSbtcfc":{"name":"init(alias:address:active:)","parent_name":"TzKTAccountDelegate"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV7balanceSo9NSDecimalaSgvp":{"name":"balance","abstract":"

The address XTZ balance in RPC format

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV4typeSSvp":{"name":"type","abstract":"

type of account e.g. “user” or “empty”

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV7addressSSvp":{"name":"address","abstract":"

tz1/2/3 kt1 address

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV9publicKeySSSgvp":{"name":"publicKey","abstract":"

prefixed public key

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV8revealedSbSgvp":{"name":"revealed","abstract":"

whether or not the account has performed a reveal operation

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV8delegateAA0dE8DelegateVSgvp":{"name":"delegate","abstract":"

The addresses delegation status

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV15delegationLevelSo9NSDecimalaSgvp":{"name":"delegationLevel","abstract":"

The block level the delegate address was set

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV17activeTokensCountSo9NSDecimalaSgvp":{"name":"activeTokensCount","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV18tokenBalancesCountSo9NSDecimalaSgvp":{"name":"tokenBalancesCount","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV10xtzBalanceAA9XTZAmountCvp":{"name":"xtzBalance","abstract":"

Helper method to convert the RPC balance into an XTZAmount

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV7balance4type7address9publicKey8revealed8delegate15delegationLevel17activeTokensCount013tokenBalancesQ0ACSo9NSDecimalaSg_S3SSbAA0dE8DelegateVSgA3Otcfc":{"name":"init(balance:type:address:publicKey:revealed:delegate:delegationLevel:activeTokensCount:tokenBalancesCount:)","abstract":"

Generic init

","parent_name":"TzKTAccount"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV6symbolSSvp":{"name":"symbol","abstract":"

The user facing symbol of the token

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV7addressSSvp":{"name":"address","abstract":"

The TZ address of the token

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV7tokenIdSo9NSDecimalavp":{"name":"tokenId","abstract":"

The token ID of the token (always 0 for FA1.2 tokens)

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV8decimalsSivp":{"name":"decimals","abstract":"

The number of decimals for the token

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV8standardAA0deF8StandardOvp":{"name":"standard","abstract":"

Which standard the token follows

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupToken"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV9sharesQtySSvp":{"name":"sharesQty","abstract":"

The liquidity token balance (rpc representation)

","parent_name":"DipDupPositionData"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV8exchangeAA0dE8ExchangeVvp":{"name":"exchange","abstract":"

The exchange the token belongs too

","parent_name":"DipDupPositionData"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV11tokenAmountAA05TokenI0CyF":{"name":"tokenAmount()","abstract":"

Convert the token data into a TokenAmount

","parent_name":"DipDupPositionData"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupPositionData"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupPositionData"},"Structs/DipDupPosition.html#/s:14KukaiCoreSwift14DipDupPositionV8positionSayAA0deF4DataVGvp":{"name":"position","parent_name":"DipDupPosition"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV4nameAA0deF4NameOvp":{"name":"name","abstract":"

Enum to denote the type of Exchange (e.g. Liquidity Baking, Quipuswap)

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV7addressSSvp":{"name":"address","abstract":"

The KT address of the exchange contract

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV7tezPoolSSvp":{"name":"tezPool","abstract":"

String representation of the Exchanges TezPool

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV9tokenPoolSSvp":{"name":"tokenPool","abstract":"

String representation of the Exchanges TokenPool

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV11sharesTotalSSvp":{"name":"sharesTotal","abstract":"

The total liquidity available (RPC representation, no decimals)

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV8midPriceSSvp":{"name":"midPrice","abstract":"

The daily middle price

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV5tokenAA0dE5TokenVvp":{"name":"token","abstract":"

The token object containing all the token info (decimals, contract address, symbol etc,)

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV13xtzPoolAmountAA9XTZAmountCyF":{"name":"xtzPoolAmount()","abstract":"

Return the XTZ pool as an XTZAmount object

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV15tokenPoolAmountAA05TokenI0CyF":{"name":"tokenPoolAmount()","abstract":"

Return the Token pool as an TokenAmount object

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV27liquidityTokenDecimalPlacesSiyF":{"name":"liquidityTokenDecimalPlaces()","abstract":"

Retrieving the liquidity token decimals is currently not supported. Hardcode the numbers for now

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV14totalLiquidityAA11TokenAmountCyF":{"name":"totalLiquidity()","abstract":"

Return the total liquidity as an TokenAmount object

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV13arePoolsEmptySbyF":{"name":"arePoolsEmpty()","abstract":"

Helper to detect if the pools are empty (determiens if the next addLiquidity will be setting the exchange rate)

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupExchange"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV6symbolSSvp":{"name":"symbol","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV7addressSSvp":{"name":"address","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV7tokenIdSo9NSDecimalavp":{"name":"tokenId","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV9exchangesSayAA0dE8ExchangeVGvp":{"name":"exchanges","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV20totalExchangeXtzPoolAA9XTZAmountCyF":{"name":"totalExchangeXtzPool()","abstract":"

Get the total XTZ pool amount from all the exchanges, useful for sorting

","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokensResponse.html#/s:14KukaiCoreSwift32DipDupExchangesAndTokensResponseV5tokenSayAA0defgH0VGvp":{"name":"token","parent_name":"DipDupExchangesAndTokensResponse"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV7averageSo9NSDecimalavp":{"name":"average","abstract":"

The average price at the given time

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV10exchangeIdSSvp":{"name":"exchangeId","abstract":"

The address of the contract

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV6bucketSSvp":{"name":"bucket","abstract":"

String representing the date and time the slice is for

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV4highSSvp":{"name":"high","abstract":"

The highest value reached in this slice

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV3lowSSvp":{"name":"low","abstract":"

The lowest value reached in this slice

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV4date10Foundation4DateVSgyF":{"name":"date()","abstract":"

Convert the bucket string into a Date object

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV13averageDoubleSdyF":{"name":"averageDouble()","abstract":"

Convert the average value into a Double

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV10highDoubleSdyF":{"name":"highDouble()","abstract":"

Convert the high value into a Double

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV9lowDoubleSdyF":{"name":"lowDouble()","abstract":"

Convert the low value into a Double

","parent_name":"DipDupChartObject"},"Structs/DipDupChartData.html#/s:14KukaiCoreSwift15DipDupChartDataV15quotes15mNogapsSayAA0deF6ObjectVGvp":{"name":"quotes15mNogaps","abstract":"

Contains the last 24 hours of data at 15 min intervals

","parent_name":"DipDupChartData"},"Structs/DipDupChartData.html#/s:14KukaiCoreSwift15DipDupChartDataV14quotes1hNogapsSayAA0deF6ObjectVGvp":{"name":"quotes1hNogaps","abstract":"

Contains every hour for past 7 days

","parent_name":"DipDupChartData"},"Structs/DipDupChartData.html#/s:14KukaiCoreSwift15DipDupChartDataV14quotes1dNogapsSayAA0deF6ObjectVGvp":{"name":"quotes1dNogaps","abstract":"

Contains every day for 30 days

","parent_name":"DipDupChartData"},"Structs/DipDupChartData.html#/s:14KukaiCoreSwift15DipDupChartDataV14quotes1wNogapsSayAA0deF6ObjectVGvp":{"name":"quotes1wNogaps","abstract":"

Contains every week for 52 weeks

","parent_name":"DipDupChartData"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV2idSSvp":{"name":"id","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV5titleSSvp":{"name":"title","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV5descrSSvp":{"name":"descr","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV4kindSSvp":{"name":"kind","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV8locationSiSgvp":{"name":"location","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV4withSSSgvp":{"name":"with","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV2idSivp":{"name":"id","abstract":"

An ID used by BCD

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV4hashSSvp":{"name":"hash","abstract":"

The operation hash

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV7counterSivp":{"name":"counter","abstract":"

The operations numeric counter

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV6statusSSvp":{"name":"status","abstract":"

Indicating if the operation was successful, failed, backtracked etc.

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV6errorsSayAA0defG5ErrorVGSgvp":{"name":"errors","abstract":"

Detailed error objects, also including unique smart contract errors

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV8isFailedSbyF":{"name":"isFailed()","abstract":"

Helper to determine if the operation failed or not

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV13containsErrorSbyF":{"name":"containsError()","abstract":"

Helper to check for existance of errors

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV17moreDetailedErrorAA0defgJ0VSgyF":{"name":"moreDetailedError()","abstract":"

When looking for more detailed errors through Better-Call.dev, effectively we are looking for an error containing a location and/or a with.","parent_name":"BetterCallDevOperation"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV10bakerAliasSSSgvp":{"name":"bakerAlias","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV9bakerLogo10Foundation3URLVSgvp":{"name":"bakerLogo","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV14paymentAddressSSvp":{"name":"paymentAddress","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV6amountAA9XTZAmountCvp":{"name":"amount","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV5cycleSivp":{"name":"cycle","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV3feeSdvp":{"name":"fee","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV13dateOfPayment10Foundation4DateVvp":{"name":"dateOfPayment","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV18meetsMinDelegationSbvp":{"name":"meetsMinDelegation","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV10bakerAlias0F4Logo14paymentAddress6amount5cycle3fee4date18meetsMinDelegationACSSSg_10Foundation3URLVSgSSAA9XTZAmountCSiSdAM4DateVSbtcfc":{"name":"init(bakerAlias:bakerLogo:paymentAddress:amount:cycle:fee:date:meetsMinDelegation:)","parent_name":"RewardDetails"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV08previousE0AA0E7DetailsVSgvp":{"name":"previousReward","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV017estimatedPreviousE0AA0E7DetailsVSgvp":{"name":"estimatedPreviousReward","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV013estimatedNextE0AA0E7DetailsVSgvp":{"name":"estimatedNextReward","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV08previousE0017estimatedPreviousE00h4NextE0AcA0E7DetailsVSg_A2Itcfc":{"name":"init(previousReward:estimatedPreviousReward:estimatedNextReward:)","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV11isOutOfDateSbyF":{"name":"isOutOfDate()","abstract":"

Creating this object involves many expensive requests, but produces a result that is valid for up to ~3 days.","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV35moreThan1CycleBetweenPreiousAndNextSbyF":{"name":"moreThan1CycleBetweenPreiousAndNext()","abstract":"

When previousReward is present, it is possible that due to a delay in payment being received, that we may cache an object before the last payment was received","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"AggregateRewardInformation"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV13walletAddressSSvp":{"name":"walletAddress","abstract":"

The wallet address

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV10xtzBalanceAA9XTZAmountCvp":{"name":"xtzBalance","abstract":"

The XTZ balance of the wallet

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV6tokensSayAA5TokenCGvp":{"name":"tokens","abstract":"

All the wallets FA1.2, FA2 funginble tokens

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV4nftsSayAA5TokenCGvp":{"name":"nfts","abstract":"

All the wallets NFT’s, grouped into parent FA2 objects so they can be displayed in groups or individaully

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV10recentNFTsSayAA3NFTVGvp":{"name":"recentNFTs","abstract":"

10 most recent NFTs to hit the wallet

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV15liquidityTokensSayAA18DipDupPositionDataVGvp":{"name":"liquidityTokens","abstract":"

All the wallets Defi, Liquidity Tokens

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV8delegateAA19TzKTAccountDelegateVSgvp":{"name":"delegate","abstract":"

TzKT object containing baker details + status

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV15delegationLevelSo9NSDecimalaSgvp":{"name":"delegationLevel","abstract":"

The block level that the delegate was set

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV13walletAddressACSS_tcfc":{"name":"init(walletAddress:)","abstract":"

Basic init to default properties to zero / empty, so that optionals can be avoided on a key model throughout an app

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV13walletAddress10xtzBalance6tokens4nfts10recentNFTs15liquidityTokens8delegate15delegationLevelACSS_AA9XTZAmountCSayAA5TokenCGAPSayAA3NFTVGSayAA18DipDupPositionDataVGAA19TzKTAccountDelegateVSgSo9NSDecimalaSgtcfc":{"name":"init(walletAddress:xtzBalance:tokens:nfts:recentNFTs:liquidityTokens:delegate:delegationLevel:)","abstract":"

Full init

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"Account"},"Structs/Account.html#/s:s12IdentifiableP2id2IDQzvp":{"name":"id","parent_name":"Account"},"Structs/Account.html":{"name":"Account","abstract":"

Fetching all the account balances is a lengthy task, involving many requests and parsing different structures."},"Structs/AggregateRewardInformation.html":{"name":"AggregateRewardInformation","abstract":"

Object ot abstract away a significatn amount of logic involved in computing estimated reward payments from a baker

"},"Structs/RewardDetails.html":{"name":"RewardDetails","abstract":"

An individual payment record denoting some payment in the past or future

"},"Structs/BetterCallDevOperation.html":{"name":"BetterCallDevOperation","abstract":"

A model matching the response that comes back from BetterCallDev’s API: v1/opg/<operation-hash>

"},"Structs/BetterCallDevOperationError.html":{"name":"BetterCallDevOperationError","abstract":"

BetterCallDev structure for errors

"},"Structs/DipDupChartData.html":{"name":"DipDupChartData","abstract":"

Struct to hold 4 arrays of data, each one mapping to a different timeline of data, to allow the display of graphs

"},"Structs/DipDupChartObject.html":{"name":"DipDupChartObject","abstract":"

Structure holding a data slice

"},"Structs/DipDupExchangesAndTokensResponse.html":{"name":"DipDupExchangesAndTokensResponse","abstract":"

Wrapper object to map to network response type

"},"Structs/DipDupExchangesAndTokens.html":{"name":"DipDupExchangesAndTokens","abstract":"

Wrapper object to map to network response type

"},"Structs/DipDupExchange.html":{"name":"DipDupExchange","abstract":"

A DipDup Exchange object with all the necessary pieces for checking liquidity and performing Swaps

"},"Structs/DipDupPosition.html":{"name":"DipDupPosition","abstract":"

Wrapper object to match network response type

"},"Structs/DipDupPositionData.html":{"name":"DipDupPositionData","abstract":"

A position on DipDup corresponds to liquidity token ownership. Each of these objects represents an amount of Liquidity tokens in an exchange for the given address

"},"Structs/DipDupToken.html":{"name":"DipDupToken","abstract":"

DipDup representation of a Token

"},"Structs/TzKTAccount.html":{"name":"TzKTAccount","abstract":"

Model mapping to TzKT.io’s Account object

"},"Structs/TzKTAccountDelegate.html":{"name":"TzKTAccountDelegate","abstract":"

Model mapping to TzKT.io’s Account.Delegate Object

"},"Structs/TzKTAddress.html":{"name":"TzKTAddress","abstract":"

Details about a given contract

"},"Structs/TzKTBaker.html":{"name":"TzKTBaker","abstract":"

Data representing a baker from TzKT or Baking-Bad

"},"Structs/TzKTBakerConfig.html":{"name":"TzKTBakerConfig","abstract":"

The bakers config file for details on when fees, min delegation etc change

"},"Structs/TzKTBakerConfigDoubleValue.html":{"name":"TzKTBakerConfigDoubleValue"},"Structs/TzKTBakerConfigIntValue.html":{"name":"TzKTBakerConfigIntValue"},"Structs/TzKTBakerConfigRewardStruct.html":{"name":"TzKTBakerConfigRewardStruct","abstract":"

Baker config payout flags

"},"Structs/TzKTBalance.html":{"name":"TzKTBalance","abstract":"

Model mapping to the Balance object returned from the new TzKT API, resulting from the merge of BCD and TzKT

"},"Structs/TzKTBalanceToken.html":{"name":"TzKTBalanceToken","abstract":"

Model encapsulating information about the token itself

"},"Structs/TzKTBalanceMetadata.html":{"name":"TzKTBalanceMetadata","abstract":"

Metadata object for the token

"},"Structs/TzKTBalanceMetadataAttributeKeyValue.html":{"name":"TzKTBalanceMetadataAttributeKeyValue","abstract":"

Wrapper / Helper to extract metadata attribute content

"},"Structs/TzKTBalanceMetadataFormat.html":{"name":"TzKTBalanceMetadataFormat","abstract":"

Object containing information about the various formats the media is available in

"},"Structs/TzKTBalanceMetadataDimensions.html":{"name":"TzKTBalanceMetadataDimensions","abstract":"

Object containing information about the dimensions of a given piece of media

"},"Structs/TzKTCycle.html":{"name":"TzKTCycle","abstract":"

The blockchain is broken down into cycles that last 2.7 days. Baker payment logic resolves around cycles instead of blocks

"},"Structs/TzKTDelegatorReward.html":{"name":"TzKTDelegatorReward","abstract":"

An object containing info on the reward a delegator should receive from a baker

"},"Structs/TzKTOperation.html":{"name":"TzKTOperation","abstract":"

A model matching the response that comes back from TzKT’s API: v1/operations/<operation-hash>

"},"Structs/TzKTOperationError.html":{"name":"TzKTOperationError","abstract":"

TzKT’s more basic error object response

"},"Structs/TzKTTokenTransfer.html":{"name":"TzKTTokenTransfer","abstract":"

FA1.2 / FA2 token transafers are treated differently from transactions. This object is used when fetching data form the API, as a temporary placeholder, ultimately to be merged into the transactions

"},"Structs/TzKTTransaction.html":{"name":"TzKTTransaction","abstract":"

A model matching the response that comes back from TzKT’s API: v1/accounts/<address>/operations

"},"Structs/TzKTTransactionGroup.html":{"name":"TzKTTransactionGroup","abstract":"

Artifical object used to group related transactions into a more user friendly display"},"Structs/BlockchainHead.html":{"name":"BlockchainHead","abstract":"

Structure representing the HEAD of the blockchain

"},"Structs/LoggingConfig.html":{"name":"LoggingConfig","abstract":"

A struct to control what messages get logged

"},"Structs/TezosNodeClientConfig.html":{"name":"TezosNodeClientConfig","abstract":"

A configuration object used to provide settings to the TezosNodeClient

"},"Structs/QuipuswapExchangeLedgerKey.html":{"name":"QuipuswapExchangeLedgerKey","abstract":"

The gneric container object holding the raw data

"},"Structs/QuipuswapExchangeLedger.html":{"name":"QuipuswapExchangeLedger","abstract":"

The unique data inside the Ledger BigMap

"},"Structs/QuipuswapExchangeStorageResponse.html":{"name":"QuipuswapExchangeStorageResponse","abstract":"

Network wrapper object

"},"Structs/QuipuswapExchangeStorage.html":{"name":"QuipuswapExchangeStorage","abstract":"

Unique Quipuswap contract storage object

"},"Structs/QuipuswapExchangeUserRewardsKey.html":{"name":"QuipuswapExchangeUserRewardsKey","abstract":"

The gneric container object holding the raw data

"},"Structs/QuipuswapExchangeUserRewards.html":{"name":"QuipuswapExchangeUserRewards","abstract":"

The unique data inside the User Rewards BigMap

"},"Structs/FailWithParserLiquidityBaking.html":{"name":"FailWithParserLiquidityBaking","abstract":"

Dedicated “FailWith” parser for the codes received from Liquidity Baking contract

"},"Structs/GraphQLError.html":{"name":"GraphQLError","abstract":"

GraphQL error object

"},"Structs/GraphQLResponse.html":{"name":"GraphQLResponse","abstract":"

Simple model object to wrap a GraphQL response to expose a Codable response without having to use large GraphQL libraries

"},"Structs/ObjktCollections.html":{"name":"ObjktCollections","abstract":"

GarpQL bulk response for a group of collections

"},"Structs/ObjktCollection.html":{"name":"ObjktCollection","abstract":"

Single collection item

"},"Structs/ObjktCreator.html":{"name":"ObjktCreator"},"Structs/ObjktTokenReponse.html":{"name":"ObjktTokenReponse","abstract":"

GarpQL response for required data for a given token

"},"Structs/ObjktToken.html":{"name":"ObjktToken","abstract":"

Single token item

"},"Structs/ObjktAttribute.html":{"name":"ObjktAttribute"},"Structs/ObjktAttributeData.html":{"name":"ObjktAttributeData"},"Structs/ObjktAttributeCounts.html":{"name":"ObjktAttributeCounts"},"Structs/ObjktSale.html":{"name":"ObjktSale"},"Structs/ObjktListing.html":{"name":"ObjktListing"},"Structs/ObjktEvent.html":{"name":"ObjktEvent","abstract":"

Single event item

"},"Structs/ObjktFa.html":{"name":"ObjktFa","abstract":"

Single FA item

"},"Structs/TezosDomainsAddressBulkResponse.html":{"name":"TezosDomainsAddressBulkResponse","abstract":"

Response object wrapper for querying an address in bulk

"},"Structs/TezosDomainsDomains.html":{"name":"TezosDomainsDomains","abstract":"

Object containing an array of domains

"},"Structs/TezosDomainsAddressResponse.html":{"name":"TezosDomainsAddressResponse","abstract":"

Response object wrapper for querying an address

"},"Structs/TezosDomainsDomain.html":{"name":"TezosDomainsDomain","abstract":"

Domain object containing details about the domain

"},"Structs/TezosDomainsDomainResponse.html":{"name":"TezosDomainsDomainResponse","abstract":"

Response object wrapper for querying a reverse record

"},"Structs/TezosDomainsDomainBulkResponse.html":{"name":"TezosDomainsDomainBulkResponse","abstract":"

Response object wrapper for querying a reverse record in bulk

"},"Structs/TezosDomainsReverseRecords.html":{"name":"TezosDomainsReverseRecords","abstract":"

Object containing an array of reverse records

"},"Structs/TezosDomainsReverseRecord.html":{"name":"TezosDomainsReverseRecord","abstract":"

Object containing all the info of the tezos domains record

"},"Structs/LiquidityBakingData.html":{"name":"LiquidityBakingData","abstract":"

Wrapper object to hold onto all the necessary data in order to work with liquidity baking contract (swap, add or remove liqudity)

"},"Structs/NFT.html":{"name":"NFT","abstract":"

An indiviual NFT (not the parent token/collection) holding a URI to an asset somewhere on the internet

"},"Structs/NetworkConstants.html":{"name":"NetworkConstants","abstract":"

The contants that a given Tezos node is using for block times, blakc size etc

"},"Structs/NetworkVersion.html":{"name":"NetworkVersion","abstract":"

The version of the Tezos code being run by the given node

"},"Structs/NilOnDecodingError.html":{"name":"NilOnDecodingError","abstract":"

property wrapper to easily handle a situation where we don’t want decoding to fail for 1 property which may be problematic. Instead just default it to nil

"},"Structs/OperationBlockHeader.html":{"name":"OperationBlockHeader"},"Structs/OperationFees.html":{"name":"OperationFees","abstract":"

A structure representing all the fees, storage and computation needed to perform an Operation

"},"Structs/OperationMetadata.html":{"name":"OperationMetadata","abstract":"

Structure representing the metadata needed by Operation‘s in order to comply with the RPC standards

"},"Structs/OperationPayload.html":{"name":"OperationPayload","abstract":"

A structure representing the request that needs to be made when sending Opertion‘s to the RPC

"},"Structs/OperationResponse.html":{"name":"OperationResponse","abstract":"

Structure representing the response returned from RPC endpoints such as .../preapply/operations

"},"Structs.html#/s:14KukaiCoreSwift24OperationResponseContentV":{"name":"OperationResponseContent","abstract":"

The main content of the JSON returned

"},"Structs.html#/s:14KukaiCoreSwift25OperationResponseMetadataV":{"name":"OperationResponseMetadata","abstract":"

The metadata belonging to the OperationResponse

"},"Structs.html#/s:14KukaiCoreSwift13BalanceUpdateV":{"name":"BalanceUpdate","abstract":"

Struct representing a change to the balance of the sender, destination or intermediary contract

"},"Structs.html#/s:14KukaiCoreSwift23OperationResponseResultV":{"name":"OperationResponseResult","abstract":"

The inner result key from the OeprationResponse

"},"Structs.html#/s:14KukaiCoreSwift025OperationResponseInternalD0V":{"name":"OperationResponseInternalOperation","abstract":"

Definition of the internal operation found inside OperationResponse

"},"Structs/OperationResponseInternalResultError.html":{"name":"OperationResponseInternalResultError","abstract":"

Definition of the outer Error object found inside OperationResponseInternalResult

"},"Structs/FailWith.html":{"name":"FailWith","abstract":"

The error string, error int (code), or micheline error object returned inside FailWith

"},"Structs.html#/s:14KukaiCoreSwift19RunOperationPayloadV":{"name":"RunOperationPayload","abstract":"

Payload object needed when sending operations to …/run_operation

"},"Structs/SVGImgProcessor.html":{"name":"SVGImgProcessor","abstract":"

SVG image processor for Kingfisher library

"},"Structs.html#/s:14KukaiCoreSwift21OperationSubscriptionV":{"name":"OperationSubscription","abstract":"

Object for sending a request through SignalR to listen to operations for a given account

"},"Structs/WalletMetadataList.html":{"name":"WalletMetadataList","abstract":"

Container to store groups of WalletMetadata based on type

"},"Structs/WalletMetadata.html":{"name":"WalletMetadata","abstract":"

Object to store UI related info about wallets, seperated from the wallet object itself to avoid issues merging together

"},"Structs/DexSwapCalculationResult.html":{"name":"DexSwapCalculationResult","abstract":"

A struct to hold all the necessary calculations for a dex trade

"},"Structs/DexAddCalculationResult.html":{"name":"DexAddCalculationResult","abstract":"

A struct to hold all the necessary calculations for adding liquidity to a dex contract

"},"Structs/DexRemoveCalculationResult.html":{"name":"DexRemoveCalculationResult","abstract":"

A struct to hold all the necessary calculations for removing liquidity from a dex contract

"},"Structs/KukaiError.html":{"name":"KukaiError","abstract":"

A struct conforming to Error, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves."},"Structs.html#/s:14KukaiCoreSwift4DAppV":{"name":"DApp"},"Structs.html#/s:14KukaiCoreSwift16OfflineConstantsV":{"name":"OfflineConstants"},"Structs/SubverifierWrapper.html":{"name":"SubverifierWrapper","abstract":"

SDK requires information about the verifer that can’t be stored inside the verifier, add a wrapper object to allow passing of all the data

"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP4typeAA0D4TypeOvp":{"name":"type","abstract":"

Which underlying WalletType is the wallet using

","parent_name":"Wallet"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP7addressSSvp":{"name":"address","abstract":"

The public TZ1 or TZ2 address of the wallet

","parent_name":"Wallet"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP4sign_11isOperation10completionySS_Sbys6ResultOySays5UInt8VGAA0A5ErrorVGctF":{"name":"sign(_:isOperation:completion:)","abstract":"

Sign a hex string with the wallets private key

","parent_name":"Wallet"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP15privateKeyCurve0a6CryptoC0010EllipticalG0OyF":{"name":"privateKeyCurve()","abstract":"

Query which curve the given wallet is using

","parent_name":"Wallet"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP22publicKeyBase58encodedSSyF":{"name":"publicKeyBase58encoded()","abstract":"

Base58 encoded version of the publicKey, used when performing a reveal operation

","parent_name":"Wallet"},"Protocols/FailWithParser.html#/s:14KukaiCoreSwift14FailWithParserP5parse04failE0SSSgAA0dE0VSg_tF":{"name":"parse(failWith:)","abstract":"

Take in a failWith and return a message

","parent_name":"FailWithParser"},"Protocols/FailWithParser.html":{"name":"FailWithParser","abstract":"

Protocol to allow defining multiple dedicated structs, one for each dApp, that knows how to convert the specific failWith cases into more human readable error messages

"},"Protocols/Wallet.html":{"name":"Wallet","abstract":"

Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

"},"Extensions/KeyedDecodingContainer.html#/s:s22KeyedDecodingContainerV14KukaiCoreSwiftE6decode_6forKeyAC05NilOnB5ErrorVyqd__GAHm_xtKSeRd__lF":{"name":"decode(_:forKey:)","parent_name":"KeyedDecodingContainer"},"Extensions/KeyedDecodingContainer.html#/s:s22KeyedDecodingContainerV14KukaiCoreSwiftE15decodeIfPresent_6forKey08orBackupK0qd__Sgqd__m_xxtKSeRd__lF":{"name":"decodeIfPresent(_:forKey:orBackupKey:)","abstract":"

In case where people have not followed the spec correctly, and named keys slightly differently, allow a second key to be used so that, for example, we could check for artifcatUri or artifact_uri in one call

","parent_name":"KeyedDecodingContainer"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftSDySSypGRszlE12michelsonInt7atIndexSSSgSi_tF":{"name":"michelsonInt(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftSDySSypGRszlE15michelsonString7atIndexSSSgSi_tF":{"name":"michelsonString(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftSDySSypGRszlE13michelsonPair7atIndexABSgSi_tF":{"name":"michelsonPair(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftypRszlE12michelsonInt7atIndexSSSgSi_tF":{"name":"michelsonInt(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftypRszlE15michelsonString7atIndexSSSgSi_tF":{"name":"michelsonString(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftypRszlE13michelsonPair7atIndexSDySSypGSgSi_tF":{"name":"michelsonPair(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftypRszlE14michelsonArray7atIndexSayypGSgSi_tF":{"name":"michelsonArray(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftAA9OperationCRszlE14copyOperationsSayACGyF":{"name":"copyOperations()","abstract":"

Operation’s are classes, passed by reference, but often require making copies so that you can manipulate them before sending to be estimated.","parent_name":"Array"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE14michelsonValueSDySSypGSgyF":{"name":"michelsonValue()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE19michelsonValueArraySaySDySSypGGSgyF":{"name":"michelsonValueArray()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE18michelsonArgsArraySaySDySSypGGSgyF":{"name":"michelsonArgsArray()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE25michelsonArgsUnknownArraySayypGSgyF":{"name":"michelsonArgsUnknownArray()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE12michelsonIntSSSgyF":{"name":"michelsonInt()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE15michelsonStringSSSgyF":{"name":"michelsonString()","parent_name":"Dictionary"},"Extensions/NSImage.html#/cgImage":{"name":"cgImage","parent_name":"NSImage"},"Extensions/NSImage.html#/init(named:)":{"name":"init(named:)","parent_name":"NSImage"},"Extensions/Thread.html#/s:So8NSThreadC14KukaiCoreSwiftE15isRunningXCTestSbvp":{"name":"isRunningXCTest","abstract":"

Check if the given thread is being run from inside an XCTest bundle

","parent_name":"Thread"},"Extensions/String.html#/s:SS14KukaiCoreSwiftE9indexesOf6stringSaySS5IndexVGSS_tF":{"name":"indexesOf(string:)","abstract":"

Return the starting indexes of each occurnace of the supplied string

","parent_name":"String"},"Extensions/String.html#/s:SS14KukaiCoreSwiftE33removeLeadingProtocolFromRPCErrorSSSgyF":{"name":"removeLeadingProtocolFromRPCError()","abstract":"

When an error is returned in the format proto.012-Psithaca.gas_exhausted.operation, in many cases we only care about the bit after the protocol. This function returns only that piece

","parent_name":"String"},"Extensions/Result.html#/s:s6ResultO14KukaiCoreSwiftE8getErrorq_yKF":{"name":"getError()","abstract":"

Similar to Result.get(), getError returns the failure case or throws

","parent_name":"Result"},"Extensions/Result.html#/s:s6ResultO14KukaiCoreSwiftAC0B5ErrorVRs_rlE10getFailureAEyF":{"name":"getFailure()","abstract":"

Similar to Result.get(), getFailure returns the kukai-core-specific KukaiError case or throws

","parent_name":"Result"},"Extensions/AnyPublisher.html#/s:7Combine12AnyPublisherV14KukaiCoreSwiftE4justyACyxq_GxFZ":{"name":"just(_:)","abstract":"

Helper for returning a Just publisher, with the appropriate Failure type and erased to AnyPublisher

","parent_name":"AnyPublisher"},"Extensions/AnyPublisher.html#/s:7Combine12AnyPublisherV14KukaiCoreSwiftE4fail4withACyxq_Gq__tFZ":{"name":"fail(with:)","abstract":"

Helper for returning a Fail publisher, erased to AnyPublisher

","parent_name":"AnyPublisher"},"Extensions/AnyPublisher.html#/s:7Combine12AnyPublisherV14KukaiCoreSwiftE15onReceiveOutputyAA10PublishersO12HandleEventsVy_ACyxq_GGyxcF":{"name":"onReceiveOutput(_:)","abstract":"

Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

","parent_name":"AnyPublisher"},"Extensions/AnyPublisher.html#/s:7Combine12AnyPublisherV14KukaiCoreSwiftE4sink7onError0H7Success0H8CompleteAA0B11CancellableCyq_c_yxcyycSgtF":{"name":"sink(onError:onSuccess:onComplete:)","abstract":"

Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

","parent_name":"AnyPublisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE8asFutureAA0G0Cy6OutputQzs5NeverOGyF":{"name":"asFuture()","abstract":"

Wrap a Publisher in a Future of type <Output, Never>

","parent_name":"Publisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE16asDeferredFutureAA0G0VyAA0H0Cy6OutputQzs5NeverOGGyF":{"name":"asDeferredFuture()","abstract":"

Wrap a Publisher in a Deferred Future of type <Output, Never>

","parent_name":"Publisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE15convertToResultAA03AnyB0Vys0H0Oy6OutputQz7FailureQzGs5NeverOGyF":{"name":"convertToResult()","abstract":"

Convert a publisher output into a swift Resultobject to make handling sink‘s easier

","parent_name":"Publisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE15onReceiveOutputyAA10PublishersO12HandleEventsVy_xGy0H0QzcF":{"name":"onReceiveOutput(_:)","abstract":"

Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

","parent_name":"Publisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE4sink7onError0G7Success0G8CompleteAA14AnyCancellableCy7FailureQzc_y6OutputQzcyycSgtF":{"name":"sink(onError:onSuccess:onComplete:)","abstract":"

Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

","parent_name":"Publisher"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE05kukaidE0ACvpZ":{"name":"kukaiCoreSwift","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE11walletCacheACvpZ":{"name":"walletCache","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE05kukaidE5ErrorACvpZ":{"name":"kukaiCoreSwiftError","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE8keychainACvpZ":{"name":"keychain","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE7networkACvpZ":{"name":"network","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE3bcdACvpZ":{"name":"bcd","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE4tzktACvpZ":{"name":"tzkt","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE14taquitoServiceACvpZ":{"name":"taquitoService","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE5torusACvpZ":{"name":"torus","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE6ledgerACvpZ":{"name":"ledger","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE3appACvpZ":{"name":"app","abstract":"

Used by the app importing this library

","parent_name":"Logger"},"Extensions/Error.html#/s:s5ErrorP14KukaiCoreSwiftE4codeSivp":{"name":"code","abstract":"

Access NSError.code

","parent_name":"Error"},"Extensions/Error.html#/s:s5ErrorP14KukaiCoreSwiftE6domainSSvp":{"name":"domain","abstract":"

Access NSError.domain

","parent_name":"Error"},"Extensions/Error.html#/s:s5ErrorP14KukaiCoreSwiftE8userInfoSDySSypGvp":{"name":"userInfo","abstract":"

Access NSError.userInfo

","parent_name":"Error"},"Extensions/Error.html#/s:s5ErrorP14KukaiCoreSwiftE010underlyingA0So7NSErrorCSgvp":{"name":"underlyingError","abstract":"

Access NSError.userInfo[NSUnderlyingErrorKey] and cast to swift Error

","parent_name":"Error"},"Extensions/Decimal.html#/s:So9NSDecimala14KukaiCoreSwiftE7rounded5scale12roundingModeABSi_So010NSRoundingH0VtF":{"name":"rounded(scale:roundingMode:)","abstract":"

Wrapper around the Objective-c code needed to round a Decimal

","parent_name":"Decimal"},"Extensions/Decimal.html#/s:So9NSDecimala14KukaiCoreSwiftE8intValueSiyF":{"name":"intValue()","abstract":"

Wrapper around the Objective-c code needed to return an Int from a decimal

","parent_name":"Decimal"},"Extensions/DateFormatter.html#/s:So15NSDateFormatterC14KukaiCoreSwiftE10withFormatABSS_tcfc":{"name":"init(withFormat:)","abstract":"

Helper to create a DateFormatter with a format in 1 call

","parent_name":"DateFormatter"},"Extensions/Date.html#/s:10Foundation4DateV14KukaiCoreSwiftE14timeAgoDisplaySSyF":{"name":"timeAgoDisplay()","abstract":"

Helper to return strings like “15 seconds ago”, “1 minute ago” etc, from a Date

","parent_name":"Date"},"Extensions/Collection.html#/s:Sl14KukaiCoreSwiftE4safe7ElementQzSg5IndexQz_tcip":{"name":"subscript(safe:)","abstract":"

Returns the element at the specified index if it is within bounds, otherwise nil.

","parent_name":"Collection"},"Extensions/Collection.html#/s:Sl14KukaiCoreSwift7Combine9Publisher7ElementRpzrlE21concatenatePublishersAB03AnyE0VyAD_6OutputQZAD_7FailureQZGSgyF":{"name":"concatenatePublishers()","abstract":"

Convert an array of publishers into a concatenation, so that they will all run sequentually. Code from: https://www.apeth.com/UnderstandingCombine/operators/operatorsJoiners/operatorsappend.html

","parent_name":"Collection"},"Extensions/Collection.html":{"name":"Collection"},"Extensions/Date.html":{"name":"Date"},"Extensions/DateFormatter.html":{"name":"DateFormatter"},"Extensions/Decimal.html":{"name":"Decimal"},"Extensions/Error.html":{"name":"Error","abstract":"

Exposing underlying NSError properties not accessible to Swift Error without casting

"},"Extensions/Logger.html":{"name":"Logger","abstract":"

Extension to OSLog to create some custom categories for logging

"},"Extensions/Publisher.html":{"name":"Publisher"},"Extensions/AnyPublisher.html":{"name":"AnyPublisher"},"Extensions/Result.html":{"name":"Result"},"Extensions/String.html":{"name":"String"},"Extensions/Thread.html":{"name":"Thread"},"Extensions/NSImage.html":{"name":"NSImage","abstract":"

Create standard UIImage properties and methods

"},"Extensions.html#/s:14KukaiCoreSwift16LossyCodableListV":{"name":"LossyCodableList"},"Extensions/Dictionary.html":{"name":"Dictionary","abstract":"

Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

"},"Extensions/Array.html":{"name":"Array","abstract":"

Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

"},"Extensions/KeyedDecodingContainer.html":{"name":"KeyedDecodingContainer"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO15missingVerifieryA2CmF":{"name":"missingVerifier","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO07invalidD8ResponseyA2CmF":{"name":"invalidTorusResponse","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO06cryptoF0yA2CmF":{"name":"cryptoError","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO18invalidNodeDetailsyA2CmF":{"name":"invalidNodeDetails","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO17invalidTwitterURLyA2CmF":{"name":"invalidTwitterURL","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO20noTwiiterUserIdFoundyA2CmF":{"name":"noTwiiterUserIdFound","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO20invalidAppleResponseyA2CmF":{"name":"invalidAppleResponse","parent_name":"TorusAuthError"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO5appleyA2CmF":{"name":"apple","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO6googleyA2CmF":{"name":"google","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO8facebookyA2CmF":{"name":"facebook","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO7twitteryA2CmF":{"name":"twitter","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO6reddityA2CmF":{"name":"reddit","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO7discordyA2CmF":{"name":"discord","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO6twitchyA2CmF":{"name":"twitch","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO4lineyA2CmF":{"name":"line","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO6githubyA2CmF":{"name":"github","parent_name":"TorusAuthProvider"},"Enums/DAppAccessType.html#/s:14KukaiCoreSwift14DAppAccessTypeO3allyA2CmF":{"name":"all","parent_name":"DAppAccessType"},"Enums/DAppAccessType.html#/s:14KukaiCoreSwift14DAppAccessTypeO14directAuthOnlyyA2CmF":{"name":"directAuthOnly","parent_name":"DAppAccessType"},"Enums/DAppAccessType.html#/s:14KukaiCoreSwift14DAppAccessTypeO4noneyA2CmF":{"name":"none","parent_name":"DAppAccessType"},"Enums/DAppCategory.html#/s:14KukaiCoreSwift12DAppCategoryO11marketplaceyA2CmF":{"name":"marketplace","parent_name":"DAppCategory"},"Enums/DAppCategory.html#/s:14KukaiCoreSwift12DAppCategoryO8exchangeyA2CmF":{"name":"exchange","parent_name":"DAppCategory"},"Enums/DAppCategory.html#/s:14KukaiCoreSwift12DAppCategoryO11collectibleyA2CmF":{"name":"collectible","parent_name":"DAppCategory"},"Enums/CacheType.html#/s:14KukaiCoreSwift9CacheTypeO9temporaryyA2CmF":{"name":"temporary","parent_name":"CacheType"},"Enums/CacheType.html#/s:14KukaiCoreSwift9CacheTypeO9permanentyA2CmF":{"name":"permanent","parent_name":"CacheType"},"Enums/MediaProxyServiceError.html#/s:14KukaiCoreSwift22MediaProxyServiceErrorO28noMimeTypeFoundInsideFormatsyA2CmF":{"name":"noMimeTypeFoundInsideFormats","parent_name":"MediaProxyServiceError"},"Enums/MediaProxyServiceError.html#/s:14KukaiCoreSwift22MediaProxyServiceErrorO24unableToParseContentTypeyA2CmF":{"name":"unableToParseContentType","parent_name":"MediaProxyServiceError"},"Enums/WalletError.html#/s:14KukaiCoreSwift11WalletErrorO09signatureE0yA2CmF":{"name":"signatureError","parent_name":"WalletError"},"Enums/WalletType.html#/s:14KukaiCoreSwift10WalletTypeO7regularyA2CmF":{"name":"regular","parent_name":"WalletType"},"Enums/WalletType.html#/s:14KukaiCoreSwift10WalletTypeO2hdyA2CmF":{"name":"hd","parent_name":"WalletType"},"Enums/WalletType.html#/s:14KukaiCoreSwift10WalletTypeO6socialyA2CmF":{"name":"social","parent_name":"WalletType"},"Enums/WalletType.html#/s:14KukaiCoreSwift10WalletTypeO6ledgeryA2CmF":{"name":"ledger","parent_name":"WalletType"},"Enums/FaVersion.html#/s:14KukaiCoreSwift9FaVersionO5fa1_2yA2CmF":{"name":"fa1_2","parent_name":"FaVersion"},"Enums/FaVersion.html#/s:14KukaiCoreSwift9FaVersionO3fa2yA2CmF":{"name":"fa2","parent_name":"FaVersion"},"Enums/FaVersion.html#/s:14KukaiCoreSwift9FaVersionO7unknownyA2CmF":{"name":"unknown","parent_name":"FaVersion"},"Enums/FaVersion.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"FaVersion"},"Enums/OperationTransactionError.html#/s:14KukaiCoreSwift25OperationTransactionErrorO21invalidMichelsonValueyA2CmF":{"name":"invalidMichelsonValue","parent_name":"OperationTransactionError"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO11transactionyA2CmF":{"name":"transaction","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO6revealyA2CmF":{"name":"reveal","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO10delegationyA2CmF":{"name":"delegation","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO11originationyA2CmF":{"name":"origination","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO16activate_accountyA2CmF":{"name":"activate_account","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO11endorsementyA2CmF":{"name":"endorsement","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO21seed_nonce_revelationyA2CmF":{"name":"seed_nonce_revelation","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO27double_endorsement_evidenceyA2CmF":{"name":"double_endorsement_evidence","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO22double_baking_evidenceyA2CmF":{"name":"double_baking_evidence","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO9proposalsyA2CmF":{"name":"proposals","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO6ballotyA2CmF":{"name":"ballot","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO7unknownyA2CmF":{"name":"unknown","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationKind"},"Enums/HDWalletError.html#/s:14KukaiCoreSwift13HDWalletErrorO013invalidWalletbG0yA2CmF":{"name":"invalidWalletCoreWallet","parent_name":"HDWalletError"},"Enums/CurrentDevice.html#/s:14KukaiCoreSwift13CurrentDeviceO11isSimulatorSbvpZ":{"name":"isSimulator","abstract":"

Is the current device a simulator

","parent_name":"CurrentDevice"},"Enums/CurrentDevice.html#/s:14KukaiCoreSwift13CurrentDeviceO23biometricTypeAuthorizedAA09BiometricG0OyFZ":{"name":"biometricTypeAuthorized()","parent_name":"CurrentDevice"},"Enums/CurrentDevice.html#/s:14KukaiCoreSwift13CurrentDeviceO22biometricTypeSupportedAA09BiometricG0OyFZ":{"name":"biometricTypeSupported()","parent_name":"CurrentDevice"},"Enums/BiometricType.html#/s:14KukaiCoreSwift13BiometricTypeO11unavailableyA2CmF":{"name":"unavailable","parent_name":"BiometricType"},"Enums/BiometricType.html#/s:14KukaiCoreSwift13BiometricTypeO4noneyA2CmF":{"name":"none","parent_name":"BiometricType"},"Enums/BiometricType.html#/s:14KukaiCoreSwift13BiometricTypeO7touchIDyA2CmF":{"name":"touchID","parent_name":"BiometricType"},"Enums/BiometricType.html#/s:14KukaiCoreSwift13BiometricTypeO6faceIDyA2CmF":{"name":"faceID","parent_name":"BiometricType"},"Enums/TzKTBakerTiming.html#/s:14KukaiCoreSwift15TzKTBakerTimingO6stableyA2CmF":{"name":"stable","parent_name":"TzKTBakerTiming"},"Enums/TzKTBakerTiming.html#/s:14KukaiCoreSwift15TzKTBakerTimingO8unstableyA2CmF":{"name":"unstable","parent_name":"TzKTBakerTiming"},"Enums/TzKTBakerTiming.html#/s:14KukaiCoreSwift15TzKTBakerTimingO10suspiciousyA2CmF":{"name":"suspicious","parent_name":"TzKTBakerTiming"},"Enums/TzKTBakerTiming.html#/s:14KukaiCoreSwift15TzKTBakerTimingO7no_datayA2CmF":{"name":"no_data","parent_name":"TzKTBakerTiming"},"Enums/TzKTBakerAccuracy.html#/s:14KukaiCoreSwift17TzKTBakerAccuracyO7preciseyA2CmF":{"name":"precise","parent_name":"TzKTBakerAccuracy"},"Enums/TzKTBakerAccuracy.html#/s:14KukaiCoreSwift17TzKTBakerAccuracyO10inaccurateyA2CmF":{"name":"inaccurate","parent_name":"TzKTBakerAccuracy"},"Enums/TzKTBakerAccuracy.html#/s:14KukaiCoreSwift17TzKTBakerAccuracyO10suspiciousyA2CmF":{"name":"suspicious","parent_name":"TzKTBakerAccuracy"},"Enums/TzKTBakerAccuracy.html#/s:14KukaiCoreSwift17TzKTBakerAccuracyO7no_datayA2CmF":{"name":"no_data","parent_name":"TzKTBakerAccuracy"},"Enums/TzKTBakerHealth.html#/s:14KukaiCoreSwift15TzKTBakerHealthO6activeyA2CmF":{"name":"active","parent_name":"TzKTBakerHealth"},"Enums/TzKTBakerHealth.html#/s:14KukaiCoreSwift15TzKTBakerHealthO6closedyA2CmF":{"name":"closed","parent_name":"TzKTBakerHealth"},"Enums/TzKTBakerHealth.html#/s:14KukaiCoreSwift15TzKTBakerHealthO4deadyA2CmF":{"name":"dead","parent_name":"TzKTBakerHealth"},"Enums/DipDupTokenStandard.html#/s:14KukaiCoreSwift19DipDupTokenStandardO4fa12yA2CmF":{"name":"fa12","parent_name":"DipDupTokenStandard"},"Enums/DipDupTokenStandard.html#/s:14KukaiCoreSwift19DipDupTokenStandardO3fa2yA2CmF":{"name":"fa2","parent_name":"DipDupTokenStandard"},"Enums/DipDupTokenStandard.html#/s:14KukaiCoreSwift19DipDupTokenStandardO7unknownyA2CmF":{"name":"unknown","parent_name":"DipDupTokenStandard"},"Enums/DipDupTokenStandard.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"DipDupTokenStandard"},"Enums/DipDupExchangeName.html#/s:14KukaiCoreSwift18DipDupExchangeNameO9quipuswapyA2CmF":{"name":"quipuswap","parent_name":"DipDupExchangeName"},"Enums/DipDupExchangeName.html#/s:14KukaiCoreSwift18DipDupExchangeNameO2lbyA2CmF":{"name":"lb","parent_name":"DipDupExchangeName"},"Enums/DipDupExchangeName.html#/s:14KukaiCoreSwift18DipDupExchangeNameO7unknownyA2CmF":{"name":"unknown","parent_name":"DipDupExchangeName"},"Enums/DipDupExchangeName.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"DipDupExchangeName"},"Enums/ResultExtensionError.html#/s:14KukaiCoreSwift20ResultExtensionErrorO02noF5FoundyA2CmF":{"name":"noErrorFound","parent_name":"ResultExtensionError"},"Enums/ResultExtensionError.html":{"name":"ResultExtensionError"},"Enums/DipDupExchangeName.html":{"name":"DipDupExchangeName","abstract":"

Enum to wrap up the available types of Exchange on DipDup

"},"Enums/DipDupTokenStandard.html":{"name":"DipDupTokenStandard","abstract":"

Wrapping up the FA standards into an enum

"},"Enums/TzKTBakerHealth.html":{"name":"TzKTBakerHealth","abstract":"

The stability of the bakers server

"},"Enums/TzKTBakerAccuracy.html":{"name":"TzKTBakerAccuracy","abstract":"

The accuracy of the bakers payments

"},"Enums/TzKTBakerTiming.html":{"name":"TzKTBakerTiming","abstract":"

The reliability of the bakers payouts

"},"Enums/BiometricType.html":{"name":"BiometricType"},"Enums/CurrentDevice.html":{"name":"CurrentDevice","abstract":"

Enum used to get details about the current device’s capabilities

"},"Enums/HDWalletError.html":{"name":"HDWalletError","abstract":"

Error types that can be passed by failable inits

"},"Enums/OperationKind.html":{"name":"OperationKind","abstract":"

Enum representing the various kinds of supported Operation‘s

"},"Enums/OperationTransactionError.html":{"name":"OperationTransactionError"},"Enums/FaVersion.html":{"name":"FaVersion","abstract":"

Enum representing the version of tezos “FA” token contracts

"},"Enums/WalletType.html":{"name":"WalletType","abstract":"

Enum to distingush between linear (non-hd) wallets, using the Bip39 standard, and hd wallets using the Bip44 standard.

"},"Enums/WalletError.html":{"name":"WalletError","abstract":"

Possible error types that can occur when using the LedgerWallet

"},"Enums/MediaProxyServiceError.html":{"name":"MediaProxyServiceError"},"Enums/CacheType.html":{"name":"CacheType"},"Enums/DAppCategory.html":{"name":"DAppCategory"},"Enums/DAppAccessType.html":{"name":"DAppAccessType"},"Enums/TorusAuthProvider.html":{"name":"TorusAuthProvider","abstract":"

List of providers currently supported and available on the Tezos network

"},"Enums/TorusAuthError.html":{"name":"TorusAuthError","abstract":"

Custom TorusAuthService errors that cna be thrown

"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceCACycfc":{"name":"init()","abstract":"

Empty

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC5cache6wallet12childOfIndex8backedUpSbx_SiSgSbtAA0D0RzlF":{"name":"cache(wallet:childOfIndex:backedUp:)","abstract":"

Securely cache a walelt object, and record a default metadata object

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC010cacheWatchD08metadataSbAA0D8MetadataV_tF":{"name":"cacheWatchWallet(metadata:)","abstract":"

Cahce a watch wallet metadata obj, only. Metadata cahcing handled via wallet cache method

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC06deleteD011withAddress11parentIndexSbSS_SiSgtF":{"name":"deleteWallet(withAddress:parentIndex:)","abstract":"

Delete both a secure wallet entry and its related metadata object

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC011deleteWatchD07addressSbSS_tF":{"name":"deleteWatchWallet(address:)","abstract":"

Clear a watch wallet meatadata obj from the metadata cache only, does not affect actual wallet cache

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC05fetchD010forAddressAA0D0_pSgSS_tF":{"name":"fetchWallet(forAddress:)","abstract":"

Find and return the secure object for a given address

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC09deleteAllE7AndKeysSbyF":{"name":"deleteAllCacheAndKeys()","abstract":"

Delete the cached files and the assoicate keys used to encrypt it

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC28encryptAndWriteWalletsToDisk7walletsSbSDySSAA0D0_pG_tF":{"name":"encryptAndWriteWalletsToDisk(wallets:)","abstract":"

Take a dictionary of Wallet objects with their addresses as the key, serialise to JSON, encrypt and then write to disk

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC29readWalletsFromDiskAndDecryptSDySSAA0D0_pGSgyF":{"name":"readWalletsFromDiskAndDecrypt()","abstract":"

Go to the file on disk (if present), decrypt its contents and retrieve a dictionary of `Wallet’s with the key being the wallet address

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC29encryptAndWriteMetadataToDiskySbAA0dJ4ListVF":{"name":"encryptAndWriteMetadataToDisk(_:)","abstract":"

Write an ordered array of WalletMetadata to disk, replacing existing file if exists

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC30readMetadataFromDiskAndDecryptAA0dH4ListVyF":{"name":"readMetadataFromDiskAndDecrypt()","abstract":"

Return an ordered array of WalletMetadata if present on disk

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC16loadOrCreateKeysSbyF":{"name":"loadOrCreateKeys()","abstract":"

Load the key references from the secure enclave (or keychain), or create them if non exist

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC10unloadKeysyyF":{"name":"unloadKeys()","abstract":"

Clear the key refrences

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC9deleteKeyyyKF":{"name":"deleteKey()","abstract":"

Delete a key from the secure enclave

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC7encrypty10Foundation4DataVSSKF":{"name":"encrypt(_:)","abstract":"

Encrypts string using the Secure Enclave

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC7decryptySS10Foundation4DataVKF":{"name":"decrypt(_:)","abstract":"

Decrypts cipher text using the Secure Enclave

","parent_name":"WalletCacheService"},"Classes/TorusAuthService.html#/s:14KukaiCoreSwift16TorusAuthServiceC07networkF09verifiersAcA07NetworkF0C_SDyAA0dE8ProviderOAA18SubverifierWrapperVGtcfc":{"name":"init(networkService:verifiers:)","abstract":"

Setup the TorusAuthService verifiers and networking clients for testnet and mainnet, so they can be queried easier.

","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/s:14KukaiCoreSwift16TorusAuthServiceC12createWallet4from11displayOver06mockedD010completionyAA0dE8ProviderO_So16UIViewControllerCSg06CustomE0ANCSgys6ResultOyAA0dH0CAA0A5ErrorVGctF":{"name":"createWallet(from:displayOver:mockedTorus:completion:)","abstract":"

Create a TorusWallet insteace from a social media provider

","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/s:14KukaiCoreSwift16TorusAuthServiceC10getAddress4from3for10completionyAA0dE8ProviderO_SSys6ResultOySSAA0A5ErrorVGctF":{"name":"getAddress(from:for:completion:)","abstract":"

Get a TZ2 address from a social media user name. If Twitter, will first convert the username to a userid and then query

","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/s:14KukaiCoreSwift16TorusAuthServiceC13twitterLookup8username10completionySS_ys6ResultOySSAA0A5ErrorVGctF":{"name":"twitterLookup(username:completion:)","abstract":"

Take in a Twitter username and fetch the Twitter userId instead.

","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/c:@CM@KukaiCoreSwift@objc(cs)TorusAuthService(im)presentationAnchorForAuthorizationController:":{"name":"presentationAnchor(for:)","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/c:@CM@KukaiCoreSwift@objc(cs)TorusAuthService(im)authorizationController:didCompleteWithError:":{"name":"authorizationController(controller:didCompleteWithError:)","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/c:@CM@KukaiCoreSwift@objc(cs)TorusAuthService(im)authorizationController:didCompleteWithAuthorization:":{"name":"authorizationController(controller:didCompleteWithAuthorization:)","parent_name":"TorusAuthService"},"Classes/TaquitoService/TaquitoServiceError.html#/s:14KukaiCoreSwift14TaquitoServiceC0dE5ErrorO14alreadyForgingyA2EmF":{"name":"alreadyForging","parent_name":"TaquitoServiceError"},"Classes/TaquitoService/TaquitoServiceError.html#/s:14KukaiCoreSwift14TaquitoServiceC0dE5ErrorO14alreadyParsingyA2EmF":{"name":"alreadyParsing","parent_name":"TaquitoServiceError"},"Classes/TaquitoService/TaquitoServiceError.html":{"name":"TaquitoServiceError","abstract":"

Unique TaquitoService errors

","parent_name":"TaquitoService"},"Classes/TaquitoService.html#/s:14KukaiCoreSwift14TaquitoServiceC6sharedACvpZ":{"name":"shared","abstract":"

Public shared instace to avoid having multiple copies of the underlying JSContext created

","parent_name":"TaquitoService"},"Classes/TaquitoService.html#/s:14KukaiCoreSwift14TaquitoServiceC5forge16operationPayload10completionyAA09OperationH0V_ys6ResultOySSAA0A5ErrorVGctF":{"name":"forge(operationPayload:completion:)","abstract":"

Wrapper around the node package @taquito/local-forging’s forge method. Giving the ability to locally forge an OperationPayload without using an RPC, and avoiding the need to do an RPC parse against a second server.","parent_name":"TaquitoService"},"Classes/TaquitoService.html#/s:14KukaiCoreSwift14TaquitoServiceC5parse3hex10completionySS_ys6ResultOyAA16OperationPayloadVAA0A5ErrorVGctF":{"name":"parse(hex:completion:)","abstract":"

Wrapper around the node package @taquito/local-forging’s prase method. Giving the ability to locally parse a hex string back into an OperationPayload, without the need to use an RPC on a tezos node.","parent_name":"TaquitoService"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV7payloadAA0dG0Vvp":{"name":"payload","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV8forgedOpSSvp":{"name":"forgedOp","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV13watermarkedOpSSvp":{"name":"watermarkedOp","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV11blake2bHashSSvp":{"name":"blake2bHash","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV8metadataAA0D8MetadataVvp":{"name":"metadata","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV03canF5ParseSbvp":{"name":"canLedgerParse","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO18unableToSetupForgeyA2EmF":{"name":"unableToSetupForge","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO18unableToSetupParseyA2EmF":{"name":"unableToSetupParse","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO11parseFailedyA2EmF":{"name":"parseFailed","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO14signingFailureyA2EmF":{"name":"signingFailure","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO21unableToSetupPreapplyyA2EmF":{"name":"unableToSetupPreapply","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO017preapplyContainedF0yAESayAA0d22ResponseInternalResultF0VGSg_tcAEmF":{"name":"preapplyContainedError(errors:)","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO19unableToSetupInjectyA2EmF":{"name":"unableToSetupInject","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO21noRemoteParseURLFoundyA2EmF":{"name":"noRemoteParseURLFound","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html":{"name":"OperationServiceError","abstract":"

Errors that the OperationService is capable of returning

","parent_name":"OperationService"},"Classes/OperationService/LedgerPayloadPrepResponse.html":{"name":"LedgerPayloadPrepResponse","abstract":"

Used to return a bunch of formatted data, to make interacting with ledger sign operation easier

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC6configAA21TezosNodeClientConfigVvp":{"name":"config","abstract":"

The configuration object containing all the necessary settings to connect and communicate with the Tezos node

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC07networkE0AA07NetworkE0Cvp":{"name":"networkService","abstract":"

The NetworkService object that will perform all the networking calls

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC6config07networkE0AcA21TezosNodeClientConfigV_AA07NetworkE0Ctcfc":{"name":"init(config:networkService:)","abstract":"

Init a TezosNodeClient with a TezosNodeClientConfig.

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC34remoteForgeParseSignPreapplyInject17operationMetadata0L7Payload6wallet10completionyAA0dM0V_AA0dN0VAA6Wallet_pys6ResultOySSAA0A5ErrorVGctF":{"name":"remoteForgeParseSignPreapplyInject(operationMetadata:operationPayload:wallet:completion:)","abstract":"

When using remote forging, every Operation needs to be Forged, Parsed, Signed, Preapply’d and Injected to make its way into the blockchain.","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC28localForgeSignPreapplyInject17operationMetadata0K7Payload6wallet10completionyAA0dL0V_AA0dM0VAA6Wallet_pys6ResultOySSAA0A5ErrorVGctF":{"name":"localForgeSignPreapplyInject(operationMetadata:operationPayload:wallet:completion:)","abstract":"

When using local forging, every Operation needs to be Forged, Signed, Preapply’d and Injected to make its way into the blockchain.","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC18ledgerStringToSign10forgedHash16operationPayloadS2S_AA0dM0VtF":{"name":"ledgerStringToSign(forgedHash:operationPayload:)","abstract":"

Ledger can only parse operations under certain conditions. These conditions are not documented well. This function will attempt to determine whether the payload can be parsed or not, and returnt he appropriate string for the LedgerWallet sign function","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC17preapplyAndInject06forgedD09signature0J5Curve16operationPayload0L8Metadata10completionySS_Says5UInt8VG0a6CryptoC0010EllipticalK0OAA0dM0VAA0dN0Vys6ResultOySSAA0A5ErrorVGctF":{"name":"preapplyAndInject(forgedOperation:signature:signatureCurve:operationPayload:operationMetadata:completion:)","abstract":"

Preapply and Inject wrapped up as one function, for situations like Ledger Wallets, where signing is a complately different process, and must be done elsewhere

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC11remoteForge16operationPayload10completionyAA0dI0V_ys6ResultOySSAA0A5ErrorVGctF":{"name":"remoteForge(operationPayload:completion:)","abstract":"

Forge an OperationPayload remotely, so it can be sent to the RPC.

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC11remoteParse11forgeResult17operationMetadata0J7Payload10completionys0I0OySSAA0A5ErrorVG_AA0dK0VAA0dL0VyAMctF":{"name":"remoteParse(forgeResult:operationMetadata:operationPayload:completion:)","abstract":"

Parse a forged OperationPayload on a different server to ensure nobody maliciously tampared with the request.

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC8preapply16operationPayload10completionyAA0dH0V_ys6ResultOySayAA0D8ResponseVGAA0A5ErrorVGctF":{"name":"preapply(operationPayload:completion:)","abstract":"

Preapply a signed OperationPayload to check for any errors.

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC6inject11signedBytes20handlePreapplyResult10completionySS_s0K0OySayAA0D8ResponseVGAA0A5ErrorVGSgyAIySSANGctF":{"name":"inject(signedBytes:handlePreapplyResult:completion:)","abstract":"

Inject a signed bytes to become part of the next block on the blockchain

","parent_name":"OperationService"},"Classes/NetworkService/NetworkError.html#/s:14KukaiCoreSwift14NetworkServiceC0D5ErrorO5parseyAESS_tcAEmF":{"name":"parse(error:)","parent_name":"NetworkError"},"Classes/NetworkService/NetworkError.html#/s:14KukaiCoreSwift14NetworkServiceC0D5ErrorO10invalidURLyA2EmF":{"name":"invalidURL","parent_name":"NetworkError"},"Classes/NetworkService/NetworkError.html#/s:14KukaiCoreSwift14NetworkServiceC0D5ErrorO7unknownyA2EmF":{"name":"unknown","parent_name":"NetworkError"},"Classes/NetworkService/NetworkError.html#/s:14KukaiCoreSwift14NetworkServiceC0D5ErrorO04httpF0yAESi_SSSgtcAEmF":{"name":"httpError(statusCode:response:)","parent_name":"NetworkError"},"Classes/NetworkService/NetworkError.html":{"name":"NetworkError","abstract":"

Errors that can be returned by the NetworkService

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC10urlSessionSo12NSURLSessionCvp":{"name":"urlSession","abstract":"

The URLSession used to preform all the networking operations

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC13loggingConfigAA07LoggingG0Vvp":{"name":"loggingConfig","abstract":"

The URLSession used to preform all the networking operations

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC10urlSession13loggingConfigACSo12NSURLSessionC_AA07LoggingI0Vtcfc":{"name":"init(urlSession:loggingConfig:)","abstract":"

Init an NetworkService with a URLSession

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC4send3rpc11withBaseURL10completionyAA3RPCCyxG_10Foundation0J0Vys6ResultOyxAA0A5ErrorVGctSeRzlF":{"name":"send(rpc:withBaseURL:completion:)","abstract":"

A generic send function that takes an RPC, with a generic type conforming to Decodable, executes the request and returns the result.

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC7request3url6isPOST8withBody13forReturnType10completiony10Foundation3URLV_SbAJ4DataVSgxmys6ResultOyxAA0A5ErrorVGctSeRzlF":{"name":"request(url:isPOST:withBody:forReturnType:completion:)","abstract":"

A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response.","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC7request3url6isPOST8withBody13forReturnType7Combine12AnyPublisherVyxAA0A5ErrorVG10Foundation3URLV_SbAO4DataVSgxmtSeRzlF":{"name":"request(url:isPOST:withBody:forReturnType:)","abstract":"

A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response, returning it as a combine publisher.","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC16logRequestFailed13loggingConfig6isPost7fullURL7payload5error10statusCode12responseDatayAA07LoggingJ0VSg_Sb10Foundation0N0VAO0T0VSgs5Error_pSgSiSgATtFZ":{"name":"logRequestFailed(loggingConfig:isPost:fullURL:payload:error:statusCode:responseData:)","abstract":"

Logging details of request failures using os_log global logging

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC18logRequestSucceded13loggingConfig6isPost7fullURL7payload12responseDatayAA07LoggingJ0VSg_Sb10Foundation0N0VAM0Q0VSgARtFZ":{"name":"logRequestSucceded(loggingConfig:isPost:fullURL:payload:responseData:)","abstract":"

Logging details of successful requests using os_log global logging

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC15logRequestStart13loggingConfig7fullURLyAA07LoggingJ0VSg_10Foundation0L0VtFZ":{"name":"logRequestStart(loggingConfig:fullURL:)","abstract":"

Logging details when a request starts using os_log global logging

","parent_name":"NetworkService"},"Classes/ContentTypeCheckingImageDownloader.html#/s:14KukaiCoreSwift34ContentTypeCheckingImageDownloaderC17startDownloadTask7context8callback10Kingfisher0jK0VAG0gH0C18DownloadingContextV_AG011SessionDataK0C0K8CallbackVtF":{"name":"startDownloadTask(context:callback:)","parent_name":"ContentTypeCheckingImageDownloader"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO9imageOnlyyA2EmF":{"name":"imageOnly","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO9audioOnlyyA2EmF":{"name":"audioOnly","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO9videoOnlyyA2EmF":{"name":"videoOnly","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO7gifOnlyyA2EmF":{"name":"gifOnly","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO13imageAndAudioyA2EmF":{"name":"imageAndAudio","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/MediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC0D4TypeO5imageyA2EmF":{"name":"image","parent_name":"MediaType"},"Classes/MediaProxyService/MediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC0D4TypeO5audioyA2EmF":{"name":"audio","parent_name":"MediaType"},"Classes/MediaProxyService/MediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC0D4TypeO5videoyA2EmF":{"name":"video","parent_name":"MediaType"},"Classes/MediaProxyService/MediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC0D4TypeO3gifyA2EmF":{"name":"gif","parent_name":"MediaType"},"Classes/MediaProxyService/Source.html#/s:14KukaiCoreSwift17MediaProxyServiceC6SourceO4ipfsyA2EmF":{"name":"ipfs","parent_name":"Source"},"Classes/MediaProxyService/Source.html#/s:14KukaiCoreSwift17MediaProxyServiceC6SourceO3webyA2EmF":{"name":"web","parent_name":"Source"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO4iconyA2EmF":{"name":"icon","parent_name":"Format"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO5smallyA2EmF":{"name":"small","parent_name":"Format"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO6mediumyA2EmF":{"name":"medium","parent_name":"Format"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO7galleryyA2EmF":{"name":"gallery","parent_name":"Format"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO3rawyA2EmF":{"name":"raw","parent_name":"Format"},"Classes/MediaProxyService/Format.html":{"name":"Format","abstract":"

Enum denoting the avaialble sizes for media

","parent_name":"MediaProxyService"},"Classes/MediaProxyService/Source.html":{"name":"Source","abstract":"

Supported source types for proxied media

","parent_name":"MediaProxyService"},"Classes/MediaProxyService/MediaType.html":{"name":"MediaType","abstract":"

Supported media types

","parent_name":"MediaProxyService"},"Classes/MediaProxyService/AggregatedMediaType.html":{"name":"AggregatedMediaType","abstract":"

Helper to parse a collection of media types to understand its contents

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC3url13fromUriString8ofFormat7keepGif10Foundation3URLVSgSSSg_AC0L0OSbtFZ":{"name":"url(fromUriString:ofFormat:keepGif:)","abstract":"

Take a URI from a token metadata response and convert it to a useable media proxy URL

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC3url7fromUri8ofFormat7keepGif10Foundation3URLVSgAK_AC0K0OSbtFZ":{"name":"url(fromUri:ofFormat:keepGif:)","abstract":"

Take a URI from a token metadata response and convert it to a useable media proxy URL

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC12thumbnailURL6forNFT7keepGif10Foundation0H0VSgAA0J0V_SbtFZ":{"name":"thumbnailURL(forNFT:keepGif:)","abstract":"

Helper method to return a standard thumbnail URL for a NFT, taking into account some custom logic / known workarounds

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC10displayURL6forNFT7keepGif10Foundation0H0VSgAA0J0V_SbtFZ":{"name":"displayURL(forNFT:keepGif:)","abstract":"

Helper method to return a standard larger display URL for a NFT

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC03getD4Type11fromFormatsSayAC0dH0OGSayAA25TzKTBalanceMetadataFormatVG_tFZ":{"name":"getMediaType(fromFormats:)","abstract":"

Using only info from TzKTBalanceMetadataFormat determine the media type(s) of the object

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC03getD4Type11fromFormats5orURL10urlSession10completionySayAA25TzKTBalanceMetadataFormatVG_10Foundation0L0VSgSo12NSURLSessionCys6ResultOySayAC0dH0OGAA0A5ErrorVGctF":{"name":"getMediaType(fromFormats:orURL:urlSession:completion:)","abstract":"

Given multiple sources of information, attempt to find the media type the url is pointing too

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC13typesContentsyAC010AggregatedD4TypeOSgSayAC0dJ0OGFZ":{"name":"typesContents(_:)","abstract":"

Helper method to parse an array of MediaType to quickly determine its content type so UI can be easily arraged

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC15removeAllImages10completionyyyc_tFZ":{"name":"removeAllImages(completion:)","abstract":"

Clear all images from all caches

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC15removeAllImages9fromCache10completionyAA0K4TypeO_yyctFZ":{"name":"removeAllImages(fromCache:completion:)","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC18clearExpiredImagesyyFZ":{"name":"clearExpiredImages()","abstract":"

Clear only iamges from cahce that have expired

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC6sizeOf5cacheSuAA9CacheTypeO_tFZ":{"name":"sizeOf(cache:)","abstract":"

Get size in bytes

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC4load3url2to13withCacheType8fallback14downSampleSize10completiony10Foundation3URLVSg_So11UIImageViewCAA0kL0OSo0T0CSo6CGSizeVSgyAWcSgtFZ":{"name":"load(url:to:withCacheType:fallback:downSampleSize:completion:)","abstract":"

Attempt to use KingFisher library to load an image from a URL, into an UIImageView, with support for downsampling, displaying loading spinner, svgs, gifs and the permanent / temporary caching system

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC10imageCache7forType10Kingfisher05ImageH0CAA0hJ0O_tFZ":{"name":"imageCache(forType:)","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC10cacheImage3url0G4Type10completiony10Foundation3URLVSg_AA05CacheJ0OySo6CGSizeVSgctFZ":{"name":"cacheImage(url:cacheType:completion:)","abstract":"

Attempt to use KingFisher library to load an image from a URL, and store it directly in the cache for later usage. Also optional return the downloaded size via a completion block, useful for preparing table/collection view

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC8isCached3url9cacheTypeSb10Foundation3URLVSg_AA05CacheK0OtFZ":{"name":"isCached(url:cacheType:)","abstract":"

Check if a given url is already cached

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC20sizeForImageIfCached3url9cacheType10completiony10Foundation3URLVSg_AA05CacheN0OySo6CGSizeVSgctFZ":{"name":"sizeForImageIfCached(url:cacheType:completion:)","abstract":"

Check if an image is cached, and return its size if so. Useful for preparing table/collection view

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/c:@CM@KukaiCoreSwift@objc(cs)MediaProxyService(im)URLSession:downloadTask:didFinishDownloadingToURL:":{"name":"urlSession(_:downloadTask:didFinishDownloadingTo:)","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/c:@CM@KukaiCoreSwift@objc(cs)MediaProxyService(im)URLSession:task:didCompleteWithError:":{"name":"urlSession(_:task:didCompleteWithError:)","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/c:@CM@KukaiCoreSwift@objc(cs)MediaProxyService(im)URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:":{"name":"urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)","parent_name":"MediaProxyService"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO15EXC_WRONG_PARAMyA2EmF":{"name":"EXC_WRONG_PARAM","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO16EXC_WRONG_LENGTHyA2EmF":{"name":"EXC_WRONG_LENGTH","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO15EXC_INVALID_INSyA2EmF":{"name":"EXC_INVALID_INS","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO24EXC_WRONG_LENGTH_FOR_INSyA2EmF":{"name":"EXC_WRONG_LENGTH_FOR_INS","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO10EXC_REJECTyA2EmF":{"name":"EXC_REJECT","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO15EXC_PARSE_ERRORyA2EmF":{"name":"EXC_PARSE_ERROR","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO29EXC_REFERENCED_DATA_NOT_FOUNDyA2EmF":{"name":"EXC_REFERENCED_DATA_NOT_FOUND","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO16EXC_WRONG_VALUESyA2EmF":{"name":"EXC_WRONG_VALUES","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO12EXC_SECURITYyA2EmF":{"name":"EXC_SECURITY","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO16EXC_HID_REQUIREDyA2EmF":{"name":"EXC_HID_REQUIRED","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO9EXC_CLASSyA2EmF":{"name":"EXC_CLASS","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO16EXC_MEMORY_ERRORyA2EmF":{"name":"EXC_MEMORY_ERROR","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO22PIN_REMAINING_ATTEMPTSyA2EmF":{"name":"PIN_REMAINING_ATTEMPTS","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO16INCORRECT_LENGTHyA2EmF":{"name":"INCORRECT_LENGTH","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO26MISSING_CRITICAL_PARAMETERyA2EmF":{"name":"MISSING_CRITICAL_PARAMETER","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO35COMMAND_INCOMPATIBLE_FILE_STRUCTUREyA2EmF":{"name":"COMMAND_INCOMPATIBLE_FILE_STRUCTURE","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO29SECURITY_STATUS_NOT_SATISFIEDyA2EmF":{"name":"SECURITY_STATUS_NOT_SATISFIED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO31CONDITIONS_OF_USE_NOT_SATISFIEDyA2EmF":{"name":"CONDITIONS_OF_USE_NOT_SATISFIED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14INCORRECT_DATAyA2EmF":{"name":"INCORRECT_DATA","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO23NOT_ENOUGH_MEMORY_SPACEyA2EmF":{"name":"NOT_ENOUGH_MEMORY_SPACE","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO25REFERENCED_DATA_NOT_FOUNDyA2EmF":{"name":"REFERENCED_DATA_NOT_FOUND","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO19FILE_ALREADY_EXISTSyA2EmF":{"name":"FILE_ALREADY_EXISTS","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO15INCORRECT_P1_P2yA2EmF":{"name":"INCORRECT_P1_P2","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17INS_NOT_SUPPORTEDyA2EmF":{"name":"INS_NOT_SUPPORTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17CLA_NOT_SUPPORTEDyA2EmF":{"name":"CLA_NOT_SUPPORTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17TECHNICAL_PROBLEMyA2EmF":{"name":"TECHNICAL_PROBLEM","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14MEMORY_PROBLEMyA2EmF":{"name":"MEMORY_PROBLEM","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14NO_EF_SELECTEDyA2EmF":{"name":"NO_EF_SELECTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14INVALID_OFFSETyA2EmF":{"name":"INVALID_OFFSET","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14FILE_NOT_FOUNDyA2EmF":{"name":"FILE_NOT_FOUND","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17INCONSISTENT_FILEyA2EmF":{"name":"INCONSISTENT_FILE","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO23ALGORITHM_NOT_SUPPORTEDyA2EmF":{"name":"ALGORITHM_NOT_SUPPORTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO11INVALID_KCVyA2EmF":{"name":"INVALID_KCV","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO20CODE_NOT_INITIALIZEDyA2EmF":{"name":"CODE_NOT_INITIALIZED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO30ACCESS_CONDITION_NOT_FULFILLEDyA2EmF":{"name":"ACCESS_CONDITION_NOT_FULFILLED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO32CONTRADICTION_SECRET_CODE_STATUSyA2EmF":{"name":"CONTRADICTION_SECRET_CODE_STATUS","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO26CONTRADICTION_INVALIDATIONyA2EmF":{"name":"CONTRADICTION_INVALIDATION","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO12CODE_BLOCKEDyA2EmF":{"name":"CODE_BLOCKED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17MAX_VALUE_REACHEDyA2EmF":{"name":"MAX_VALUE_REACHED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14GP_AUTH_FAILEDyA2EmF":{"name":"GP_AUTH_FAILED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO9LICENSINGyA2EmF":{"name":"LICENSING","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO6HALTEDyA2EmF":{"name":"HALTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO13DEVICE_LOCKEDyA2EmF":{"name":"DEVICE_LOCKED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO7UNKNOWNyA2EmF":{"name":"UNKNOWN","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO23NO_WRITE_CHARACTERISTICyA2EmF":{"name":"NO_WRITE_CHARACTERISTIC","parent_name":"GeneralErrorCodes"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC11successCodeSSvpZ":{"name":"successCode","abstract":"

Instead of returning data, sometimes ledger returns a code to indicate that so far the message have been received successfully

","parent_name":"LedgerService"},"Classes/LedgerService/GeneralErrorCodes.html":{"name":"GeneralErrorCodes","abstract":"

General Ledger error codes, pulled from the source, and some additional ones added for native swift issues

","parent_name":"LedgerService"},"Classes/LedgerService/TezosAppErrorCodes.html":{"name":"TezosAppErrorCodes","abstract":"

Dedicated error codes pulled from the Ledger tezos app

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC29partialSuccessMessageReceivedSbvp":{"name":"partialSuccessMessageReceived","abstract":"

Be notified when the ledger device returns a success message, part way through the process.","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC6sharedACvpZ":{"name":"shared","abstract":"

Public shared instace to avoid having multiple copies of the underlying JSContext created

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC16listenForDevices7Combine12AnyPublisherVySDyS2SGAA0A5ErrorVGyF":{"name":"listenForDevices()","abstract":"

Start listening for ledger devices

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC13stopListeningyyF":{"name":"stopListening()","abstract":"

Stop listening for and reporting new ledger devices found

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC9connectTo4uuid7Combine12AnyPublisherVySbAA0A5ErrorVGSS_tF":{"name":"connectTo(uuid:)","abstract":"

Connect to a ledger device by a given UUID

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC20disconnectFromDeviceyyF":{"name":"disconnectFromDevice()","abstract":"

Disconnect from the current Ledger device

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC22getConnectedDeviceUUIDSSSgyF":{"name":"getConnectedDeviceUUID()","abstract":"

Get the UUID of the connected device

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC10getAddress17forDerivationPath5curve6verify7Combine12AnyPublisherVySS7address_SS9publicKeytAA0A5ErrorVGSS_0a6CryptoC015EllipticalCurveOSbtF":{"name":"getAddress(forDerivationPath:curve:verify:)","abstract":"

Get a TZ address and public key from the current connected Ledger device

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC4sign3hex17forDerivationPath5parse7Combine12AnyPublisherVySSAA0A5ErrorVGSS_SSSbtF":{"name":"sign(hex:forDerivationPath:parse:)","abstract":"

Sign an operation payload with the underlying secret key, returning the signature

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)centralManagerDidUpdateState:":{"name":"centralManagerDidUpdateState(_:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)centralManager:didDiscoverPeripheral:advertisementData:RSSI:":{"name":"centralManager(_:didDiscover:advertisementData:rssi:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)centralManager:didConnectPeripheral:":{"name":"centralManager(_:didConnect:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)centralManager:didFailToConnectPeripheral:error:":{"name":"centralManager(_:didFailToConnect:error:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)peripheral:didDiscoverServices:":{"name":"peripheral(_:didDiscoverServices:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)peripheral:didDiscoverCharacteristicsForService:error:":{"name":"peripheral(_:didDiscoverCharacteristicsFor:error:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)peripheral:didWriteValueForCharacteristic:error:":{"name":"peripheral(_:didWriteValueFor:error:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)peripheral:didUpdateValueForCharacteristic:error:":{"name":"peripheral(_:didUpdateValueFor:error:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/FeeEstimatorService/EstimationResult.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC16EstimationResultV10operationsSayAA9OperationCGvp":{"name":"operations","parent_name":"EstimationResult"},"Classes/FeeEstimatorService/EstimationResult.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC16EstimationResultV12forgedStringSSvp":{"name":"forgedString","parent_name":"EstimationResult"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO25tezosNodeClientNotPresentyA2EmF":{"name":"tezosNodeClientNotPresent","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO25unableToSetupRunOperationyA2EmF":{"name":"unableToSetupRunOperation","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO27invalidNumberOfFeesReturnedyA2EmF":{"name":"invalidNumberOfFeesReturned","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO22failedToCopyOperationsyA2EmF":{"name":"failedToCopyOperations","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO016estimationRemoteG0yAESayAA031OperationResponseInternalResultG0VGSg_tcAEmF":{"name":"estimationRemoteError(errors:)","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO30unsupportedWalletAddressPrefixyA2EmF":{"name":"unsupportedWalletAddressPrefix","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV15nanoTezPerMutezSivpZ":{"name":"nanoTezPerMutez","parent_name":"FeeConstants"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV07minimalD0SivpZ":{"name":"minimalFee","parent_name":"FeeConstants"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV13feePerGasUnitSivpZ":{"name":"feePerGasUnit","parent_name":"FeeConstants"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV17feePerStorageByteSivpZ":{"name":"feePerStorageByte","parent_name":"FeeConstants"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV04baseD0AA9XTZAmountCvpZ":{"name":"baseFee","parent_name":"FeeConstants"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC16defaultSignatureSays5UInt8VGvpZ":{"name":"defaultSignature","abstract":"

The real signature is not needed for estimation, use the default “Zero Signature” instead

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC19defaultSignatureHexSSvpZ":{"name":"defaultSignatureHex","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService/FeeConstants.html":{"name":"FeeConstants","abstract":"

Constants needed to compute a fee

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html":{"name":"FeeEstimatorServiceError","abstract":"

Various possible errors that can occur during an Estimation

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService/EstimationResult.html":{"name":"EstimationResult","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC6configAA21TezosNodeClientConfigVvp":{"name":"config","abstract":"

The configuration object containing all the necessary settings to connect and communicate with the Tezos node

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC09operationF0AA09OperationF0Cvp":{"name":"operationService","abstract":"

The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC07networkF0AA07NetworkF0Cvp":{"name":"networkService","abstract":"

The NetworkService that will handle the remote communication.

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC6config09operationF007networkF0AcA21TezosNodeClientConfigV_AA09OperationF0CAA07NetworkF0Ctcfc":{"name":"init(config:operationService:networkService:)","abstract":"

Create a FeeEstimatorService that will allow developers to automatically create fees on the users behalf

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC8estimate10operations17operationMetadata9constants13walletAddress22base58EncodedPublicKey10completionySayAA9OperationCG_AA0sJ0VAA16NetworkConstantsVS2Sys6ResultOyAC010EstimationV0VAA0A5ErrorVGctF":{"name":"estimate(operations:operationMetadata:constants:walletAddress:base58EncodedPublicKey:completion:)","abstract":"

Pass in an array of Operation subclasses (use OperationFacotry to create) to have the library estimate the cost of sending the transaction. Function will use local or remote forging based off config passed in.","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC11extractFees21fromOperationResponse10forgedHash13withConstantsSayAA0jH0VGAA0jK0V_SSAA07NetworkO0VtF":{"name":"extractFees(fromOperationResponse:forgedHash:withConstants:)","abstract":"

Create an array of OperationFees from an OperationResponse.

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC9feeForGasyAA9XTZAmountCSiFZ":{"name":"feeForGas(_:)","abstract":"

Calculate the fee to add for the given amount of gas

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC13feeForStorage_18numberOfOperationsAA9XTZAmountCSS_SitFZ":{"name":"feeForStorage(_:numberOfOperations:)","abstract":"

Calculate the fee to add based on the size of the forged string

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC10feeForBurn_13withConstantsAA9XTZAmountCSi_AA07NetworkK0VtFZ":{"name":"feeForBurn(_:withConstants:)","abstract":"

Calculate the fee to add based on how many bytes of storage where needed

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC12nanoTeztoXTZyAA9XTZAmountCSiFZ":{"name":"nanoTeztoXTZ(_:)","abstract":"

Most calcualtions are documented in NanoTez, which is not accpeted by the network RPC calls. Needs to be converted to Mutez / XTZ

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC3fee11forGasLimit15forgedHexString18numberOfOperationsAA9XTZAmountCSi_SSSitFZ":{"name":"fee(forGasLimit:forgedHexString:numberOfOperations:)","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC20addGasSafetyMarginTo7gasUsedS2i_tFZ":{"name":"addGasSafetyMarginTo(gasUsed:)","parent_name":"FeeEstimatorService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC6sharedACvpZ":{"name":"shared","abstract":"

Shared instance so that it can hold onto an event closure

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC17errorEventClosureyAA0aD0VcSgvp":{"name":"errorEventClosure","abstract":"

Called everytime an error is parsed. Extremely useful to track / log errors globally, in order to run logic or record to external service

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC013fromOperationD0_6andLogAA0aD0VAA0h22ResponseInternalResultD0V_SbtFZ":{"name":"fromOperationError(_:andLog:)","abstract":"

Convert an OperationResponseInternalResultError into a KukaiError and optionally log it to the central logger

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC32searchOperationResponseForErrors_6andLogAA0aD0VSgAA0hI0V_SbtFZ":{"name":"searchOperationResponseForErrors(_:andLog:)","abstract":"

Search an OperationResponse to see does it contain any errors, if so return the last one as a KukaiError and optionally log it to the central logger

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC32searchOperationResponseForErrors_6andLogAA0aD0VSgSayAA0hI0VG_SbtFZ":{"name":"searchOperationResponseForErrors(_:andLog:)","abstract":"

Search an [OperationResponse] to see does it contain any errors, if so return the last one as aKukaiError and optionally log it to the central logger

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC015searchForSystemD04data8response07networkD010requestURL0M4Data6andLogAA0aD0VSg10Foundation0O0VSg_So13NSURLResponseCSgs0D0_pSgAN0N0VAQSbtFZ":{"name":"searchForSystemError(data:response:networkError:requestURL:requestData:andLog:)","abstract":"

Take in network response data and see does it contain an error, if so return create aKukaiErrorfrom it and optionally log it to the central logger

","parent_name":"ErrorHandlingService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC5write4data10toFileName20isExcludedFromBackupSb10Foundation4DataV_SSSbtFZ":{"name":"write(data:toFileName:isExcludedFromBackup:)","abstract":"

Write an instance of Data to a given fileName

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC5write9encodable10toFileName20isExcludedFromBackupSbx_SSSbtSERzlFZ":{"name":"write(encodable:toFileName:isExcludedFromBackup:)","abstract":"

Write an instance of an object conforming to Encodable to a fileName

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC8readData12fromFileName10Foundation0G0VSgSS_tFZ":{"name":"readData(fromFileName:)","abstract":"

Read a fileName and return the contents as Data

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC4read4type12fromFileNamexSgxm_SStSeRzlFZ":{"name":"read(type:fromFileName:)","abstract":"

Read a fileName, and parse the contents as an instance of a Decodable object

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC6delete8fileNameSbSS_tFZ":{"name":"delete(fileName:)","abstract":"

Delete a fileName

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC6delete9fileNamesSbSaySSG_tFZ":{"name":"delete(fileNames:)","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC18documentsDirectory20isExcludedFromBackup10Foundation3URLVSgSb_tFZ":{"name":"documentsDirectory(isExcludedFromBackup:)","abstract":"

Get the URL to the devices documents directory, if possible

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC6exists8fileName10Foundation3URLVSgSS_tFZ":{"name":"exists(fileName:)","abstract":"

Check if a fileName exists in the documents directory or not

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC16allFileNamesWith6prefixSaySSGSS_tFZ":{"name":"allFileNamesWith(prefix:)","abstract":"

Find all files in documents directory begining with prefix

","parent_name":"DiskService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC6sharedACvpZ":{"name":"shared","abstract":"

Public shared instace to avoid having multiple copies of the underlying JSContext created

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC19calculateXtzToToken03xtzI4Sell0K4Pool05tokenM011maxSlippage3dexAA0d4SwapE6ResultVSgAA9XTZAmountC_AnA0J6AmountCSdAA18DipDupExchangeNameOtF":{"name":"calculateXtzToToken(xtzToSell:xtzPool:tokenPool:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for a xtzToToken exchange, to perform the operation and display the info to the user in a confirmation screen.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC19calculateTokenToXTZ05tokenI4Sell7xtzPool0kN011maxSlippage3dexAA0d4SwapE6ResultVSgAA0H6AmountC_AA9XTZAmountCANSdAA18DipDupExchangeNameOtF":{"name":"calculateTokenToXTZ(tokenToSell:xtzPool:tokenPool:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for a tokenToXtz exchange, to perform the operation and display the info to the user in a confirmation screen.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC21calculateAddLiquidity3xtz0J4Pool05tokenK005totalI011maxSlippage3dexAA0dhE6ResultVSgAA9XTZAmountC_AoA11TokenAmountCAQSdAA18DipDupExchangeNameOtF":{"name":"calculateAddLiquidity(xtz:xtzPool:tokenPool:totalLiquidity:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for adding liquidity, with an XTZ input

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC21calculateAddLiquidity5token7xtzPool0jL005totalI011maxSlippage3dexAA0dhE6ResultVSgAA11TokenAmountC_AA9XTZAmountCA2OSdAA18DipDupExchangeNameOtF":{"name":"calculateAddLiquidity(token:xtzPool:tokenPool:totalLiquidity:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for adding liquidity, with an Token input

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC24calculateRemoveLiquidity15liquidityBurned05totalI07xtzPool05tokenN011maxSlippage3dexAA0dhE6ResultVSgAA11TokenAmountC_AoA9XTZAmountCAOSdAA18DipDupExchangeNameOtF":{"name":"calculateRemoveLiquidity(liquidityBurned:totalLiquidity:xtzPool:tokenPool:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for removing liquidity, to return everything the user will get out

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC8settings03forD0Sd3fee_Sd4burnSb14includeSubsidytAA18DipDupExchangeNameO_tFZ":{"name":"settings(forDex:)","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC24xtzToTokenExpectedReturn0gH4Sell0G4Pool05tokenM03dexAA0I6AmountCSgAA9XTZAmountC_AmjA18DipDupExchangeNameOtF":{"name":"xtzToTokenExpectedReturn(xtzToSell:xtzPool:tokenPool:dex:)","abstract":"

The TokenAmount expected to be returned for the supplied XTZAmount, given the dex contract xtzPool and tokenPool.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC23xtzToTokenMinimumReturn11tokenAmount8slippageAA0iM0CSgAH_SdtF":{"name":"xtzToTokenMinimumReturn(tokenAmount:slippage:)","abstract":"

The minimum possible TokenAmount returned, taking into account slippage.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC24xtzToTokenRequiredXtzFor11tokenAmount0G4Pool0mO03dexAA9XTZAmountCSgAA0iN0C_AjmA18DipDupExchangeNameOtF":{"name":"xtzToTokenRequiredXtzFor(tokenAmount:xtzPool:tokenPool:dex:)","abstract":"

Calculate the XTZAmount required in order to receive the supplied TokenAmount.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC22xtzToTokenExchangeRate0gH4Sell0G4Pool05tokenM03dexSo9NSDecimalaSgAA9XTZAmountC_AmA0I6AmountCAA06DipDupJ4NameOtF":{"name":"xtzToTokenExchangeRate(xtzToSell:xtzPool:tokenPool:dex:)","abstract":"

The exchange rate for a given trade, taking into account slippage and fees

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC29xtzToTokenExchangeRateDisplay0gH4Sell0G4Pool05tokenN03dexSo9NSDecimalaSgAA9XTZAmountC_AmA0I6AmountCAA06DipDupJ4NameOtF":{"name":"xtzToTokenExchangeRateDisplay(xtzToSell:xtzPool:tokenPool:dex:)","abstract":"

The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC20xtzToTokenMarketRate0G4Pool05tokenL0So9NSDecimalaSgAA9XTZAmountC_AA0I6AmountCtF":{"name":"xtzToTokenMarketRate(xtzPool:tokenPool:)","abstract":"

Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC21xtzToTokenPriceImpact0gH4Sell0G4Pool05tokenM03dexSo9NSDecimalaSgAA9XTZAmountC_AmA0I6AmountCAA18DipDupExchangeNameOtF":{"name":"xtzToTokenPriceImpact(xtzToSell:xtzPool:tokenPool:dex:)","abstract":"

Calcualte the percentage the price impact the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC24tokenToXtzExpectedReturn0gH4Sell7xtzPool0gN03dexAA9XTZAmountCSgAA11TokenAmountC_AjmA18DipDupExchangeNameOtF":{"name":"tokenToXtzExpectedReturn(tokenToSell:xtzPool:tokenPool:dex:)","abstract":"

The XTZAmount expected to be returned for the supplied TokenAmount, given the dex contracts xtzPool and tokenPool.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC23tokenToXtzMinimumReturn9xtzAmount8slippageAA9XTZAmountCSgAH_SdtF":{"name":"tokenToXtzMinimumReturn(xtzAmount:slippage:)","abstract":"

The minimum possible XTZAmount returned, taking into account slippage.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC26tokenToXtzRequiredTokenFor9xtzAmount0M4Pool0gO03dexAA0kN0CSgAA9XTZAmountC_AmjA18DipDupExchangeNameOtF":{"name":"tokenToXtzRequiredTokenFor(xtzAmount:xtzPool:tokenPool:dex:)","abstract":"

Calculate the TokenAmount required in order to receive the supplied XTZAmount.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC22tokenToXtzExchangeRate0gH4Sell7xtzPool0gN03dexSo9NSDecimalaSgAA11TokenAmountC_AA9XTZAmountCAmA06DipDupJ4NameOtF":{"name":"tokenToXtzExchangeRate(tokenToSell:xtzPool:tokenPool:dex:)","abstract":"

The exchange rate for a given trade, taking into account slippage and fees

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC29tokenToXtzExchangeRateDisplay0gH4Sell7xtzPool0gO03dexSo9NSDecimalaSgAA11TokenAmountC_AA9XTZAmountCAmA06DipDupJ4NameOtF":{"name":"tokenToXtzExchangeRateDisplay(tokenToSell:xtzPool:tokenPool:dex:)","abstract":"

The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC20tokenToXtzMarketRate7xtzPool0gM0So9NSDecimalaSgAA9XTZAmountC_AA11TokenAmountCtF":{"name":"tokenToXtzMarketRate(xtzPool:tokenPool:)","abstract":"

Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC21tokenToXtzPriceImpact0gH4Sell7xtzPool0gN03dexSo9NSDecimalaSgAA11TokenAmountC_AA9XTZAmountCAmA18DipDupExchangeNameOtF":{"name":"tokenToXtzPriceImpact(tokenToSell:xtzPool:tokenPool:dex:)","abstract":"

Calcualte the percentage slippage the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC18addLiquidityReturn12xtzToDeposit0J4Pool05totalH08slippage3dexAA11TokenAmountC8expected_AK7minimumtSgAA9XTZAmountC_ApKSdAA18DipDupExchangeNameOtF":{"name":"addLiquidityReturn(xtzToDeposit:xtzPool:totalLiquidity:slippage:dex:)","abstract":"

Calculate the amount of liquidity tokens a user can expect back for an amount of XTZ and Token

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC25addLiquidityTokenRequired12xtzToDeposit0K4Pool05tokenN03dexAA0I6AmountCSgAA9XTZAmountC_AmjA18DipDupExchangeNameOtF":{"name":"addLiquidityTokenRequired(xtzToDeposit:xtzPool:tokenPool:dex:)","abstract":"

Calculate the amount of Token that is required to send along side your XTZ

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC23addLiquidityXtzRequired14tokenToDeposit7xtzPool0kO03dexAA9XTZAmountCSgAA11TokenAmountC_AjmA18DipDupExchangeNameOtF":{"name":"addLiquidityXtzRequired(tokenToDeposit:xtzPool:tokenPool:dex:)","abstract":"

Calculate the amount of XTZ that is required to send along side your Token

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC28removeLiquidityTokenReceived15liquidityBurned05totalH09tokenPool8slippageAA0I6AmountC8expected_AJ7minimumtSgAJ_A2JSdtF":{"name":"removeLiquidityTokenReceived(liquidityBurned:totalLiquidity:tokenPool:slippage:)","abstract":"

Calculate the amount of token a user would revice back if they burned X liquidity

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC26removeLiquidityXtzReceived15liquidityBurned05totalH07xtzPool8slippage3dexAA9XTZAmountC8expected_AK7minimumtSgAA11TokenAmountC_ApKSdAA18DipDupExchangeNameOtF":{"name":"removeLiquidityXtzReceived(liquidityBurned:totalLiquidity:xtzPool:slippage:dex:)","abstract":"

Calculate the amount of XTZ a user would revice back if they burned X liquidity

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC26estimateLiquidityBakingAPY7xtzPoolSo9NSDecimalaSgAA9XTZAmountC_tF":{"name":"estimateLiquidityBakingAPY(xtzPool:)","abstract":"

Estimate the APY of liquidity baking contract, as it has a known income.

","parent_name":"DexCalculationService"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV10FEE_FACTORSivpZ":{"name":"FEE_FACTOR","abstract":"

Constant pulled from: https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV11VETO_PERIODSo9NSDecimalavpZ":{"name":"VETO_PERIOD","abstract":"

Constant pulled from: https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV13VOTING_PERIODSo9NSDecimalavpZ":{"name":"VOTING_PERIOD","abstract":"

Constant pulled from:https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV20ACCURANCY_MULTIPLIERSo9NSDecimalavpZ":{"name":"ACCURANCY_MULTIPLIER","abstract":"

Constant pulled from: https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV17getPendingRewards12fromExchange10forAddress10tzKTClient10completionySS_SSAA02TzP0Cys6ResultOyAA9XTZAmountCAA0A5ErrorVGctFZ":{"name":"getPendingRewards(fromExchange:forAddress:tzKTClient:completion:)","abstract":"

Use TzKTClient’s methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV17getPendingRewards12fromExchange10forAddress10tzKTClient7Combine6FutureCySS8exchange_AA9XTZAmountC7rewardstAA0A5ErrorVGSS_SSAA02TzP0CtFZ":{"name":"getPendingRewards(fromExchange:forAddress:tzKTClient:)","abstract":"

Wrapper around getPendingRewards(..., completion: ) to make it easier to create bulk queries, through combine

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV21getBulkPendingRewards13fromExchanges10forAddress10tzKTClient10completionySaySSG_SSAA02TzQ0Cys6ResultOySaySS8exchange_AA9XTZAmountC7rewardstGAA0A5ErrorVGctFZ":{"name":"getBulkPendingRewards(fromExchanges:forAddress:tzKTClient:completion:)","abstract":"

Use TzKTClient’s methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html":{"name":"Quipuswap","abstract":"

All functions related to Quipuswap

","parent_name":"DAppHelperService"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC13fromRpcAmountACSgSS_tcfc":{"name":"init(fromRpcAmount:)","abstract":"

Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC13fromRpcAmountACSgSo9NSDecimala_tcfc":{"name":"init(fromRpcAmount:)","abstract":"

Set the internal balance, using a decimal version of an RPC amount. e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC20fromNormalisedAmountACSo9NSDecimala_tcfc":{"name":"init(fromNormalisedAmount:)","abstract":"

Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC20fromNormalisedAmount13decimalPlacesACSgSS_Sitcfc":{"name":"init(fromNormalisedAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC4zeroACyFZ":{"name":"zero()","abstract":"

Quickly create a XTZAmount with zero balance.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info.","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC1poiyA2C_ACtFZ":{"name":"+(_:_:)","abstract":"

Overload + operator to allow users to add two Token amounts of the same type, together.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC2peoiyyACz_ACtFZ":{"name":"+=(_:_:)","abstract":"

Overload += operator to allow users to add two Token amounts of the same type, together in place.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC1soiyA2C_ACtFZ":{"name":"-(_:_:)","abstract":"

Overload - operator to allow users to subtract two Token amounts of the same type.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC2seoiyyACz_ACtFZ":{"name":"-=(_:_:)","abstract":"

Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC1moiySo9NSDecimalaAC_AFtFZ":{"name":"*(_:_:)","abstract":"

Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC1moiyA2C_SitFZ":{"name":"*(_:_:)","abstract":"

Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

","parent_name":"XTZAmount"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC12authProviderAA0d4AuthG0Ovp":{"name":"authProvider","abstract":"

The type of service used to generate the provide key

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC14socialUsernameSSSgvp":{"name":"socialUsername","abstract":"

The raw social media username displayed on the users account. In the case of Twitter, it will not be prefix with an @

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC12socialUserIdSSSgvp":{"name":"socialUserId","abstract":"

The unique id the social media platform has assigned to the users account. Used for querying account details

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC23socialProfilePictureURL10Foundation0I0VSgvp":{"name":"socialProfilePictureURL","abstract":"

A URL to the users profile picture on the given social meida platform

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC12authProvider8username6userId14profilePicture15torusPrivateKeyACSgAA0d4AuthG0O_SSSgA2LSStcfc":{"name":"init(authProvider:username:userId:profilePicture:torusPrivateKey:)","abstract":"

Create an instace of the wallet from the data provided by the Torus network, using TorusAuthService

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Encodable encode func

","parent_name":"TorusWallet"},"Classes/TokenAmount/TokenAmountError.html#/s:14KukaiCoreSwift11TokenAmountC0dE5ErrorO20invalidStringFromRPCyA2EmF":{"name":"invalidStringFromRPC","parent_name":"TokenAmountError"},"Classes/TokenAmount/TokenAmountError.html":{"name":"TokenAmountError","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"

The number of decimal places that this token supports.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC17rpcRepresentationSSvp":{"name":"rpcRepresentation","abstract":"

Format the internal value to ensure it matches the format the RPC will expect

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC24normalisedRepresentationSSvp":{"name":"normalisedRepresentation","abstract":"

Basic formatting of a token to be human readable. For more advanced options, use the format function

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC07fromRpcE013decimalPlacesACSgSS_Sitcfc":{"name":"init(fromRpcAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC07fromRpcE013decimalPlacesACSgSo9NSDecimala_Sitcfc":{"name":"init(fromRpcAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a decimal version of an RPC amount. e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC014fromNormalisedE013decimalPlacesACSo9NSDecimala_Sitcfc":{"name":"init(fromNormalisedAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC014fromNormalisedE013decimalPlacesACSgSS_Sitcfc":{"name":"init(fromNormalisedAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC4zeroACyFZ":{"name":"zero()","abstract":"

Quickly create a TokenAmount with zero balance and no decimal places.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC11zeroBalance13decimalPlacesACSi_tFZ":{"name":"zeroBalance(decimalPlaces:)","abstract":"

Quickly create a TokenAmount with zero balance.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC30formatNormalisedRepresentation6localeSSSg10Foundation6LocaleV_tF":{"name":"formatNormalisedRepresentation(locale:)","abstract":"

Format the current value into a human readable string, using the given locale.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC12toRpcDecimalSo9NSDecimalaSgyF":{"name":"toRpcDecimal()","abstract":"

Function to convert the underlying rpc value into a Decimal which can be useful in some situations for integrating with other tools and frameworks.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC19toNormalisedDecimalSo9NSDecimalaSgyF":{"name":"toNormalisedDecimal()","abstract":"

Function to convert the underlying normalised value into a Decimal which can be useful in some situations for integrating with other tools and frameworks.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC11toXTZAmountAA0G0CyF":{"name":"toXTZAmount()","abstract":"

Currently we are unable to cast directly from TokenAmount to XTZAmount. This function will create a new XTZAmount object from the TokenAmount.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1poiyA2C_ACtFZ":{"name":"+(_:_:)","abstract":"

Overload + operator to allow users to add two Token amounts of the same type, together.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC2peoiyyACz_ACtFZ":{"name":"+=(_:_:)","abstract":"

Overload += operator to allow users to add two Token amounts of the same type, together in place.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1soiyA2C_ACtFZ":{"name":"-(_:_:)","abstract":"

Overload - operator to allow users to subtract two Token amounts of the same type.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC2seoiyyACz_ACtFZ":{"name":"-=(_:_:)","abstract":"

Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1moiySo9NSDecimalaAC_AFtFZ":{"name":"*(_:_:)","abstract":"

Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1moiyA2C_SitFZ":{"name":"*(_:_:)","abstract":"

Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1loiySbAC_ACtFZ":{"name":"<(_:_:)","abstract":"

Conforming to Comparable

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC11descriptionSSvp":{"name":"description","abstract":"

Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"TokenAmount"},"Classes/Token/TokenType.html#/s:14KukaiCoreSwift5TokenC0D4TypeO3xtzyA2EmF":{"name":"xtz","parent_name":"TokenType"},"Classes/Token/TokenType.html#/s:14KukaiCoreSwift5TokenC0D4TypeO8fungibleyA2EmF":{"name":"fungible","parent_name":"TokenType"},"Classes/Token/TokenType.html#/s:14KukaiCoreSwift5TokenC0D4TypeO11nonfungibleyA2EmF":{"name":"nonfungible","parent_name":"TokenType"},"Classes/Token/TokenType.html":{"name":"TokenType","abstract":"

An Enum to express the type of a token. Different processes are needed to fetch a balance for a users XTZ wallet,","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4nameSSSgvp":{"name":"name","abstract":"

The long name of a token. e.g. “Tezos”.

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC6symbolSSvp":{"name":"symbol","abstract":"

The short name or the symbol of a token. e.g. “XTZ”.

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC9tokenTypeAC0dF0Ovp":{"name":"tokenType","abstract":"

The type of this token. e.g. xtz, fungible, nonfungible

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC9faVersionAA02FaF0OSgvp":{"name":"faVersion","abstract":"

The FaVersion of the token contract, nil for XTZ

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC7balanceAA0D6AmountCvp":{"name":"balance","abstract":"

Object that holds and formats the balance of the token

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"

Get the underlying number of decimal places that this token represents

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC12thumbnailURL10Foundation0F0VSgvp":{"name":"thumbnailURL","abstract":"

The URL to a cached version of the asset (data that we add later on through other service calls)

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC17localCurrencyRateSo9NSDecimalavp":{"name":"localCurrencyRate","abstract":"

The current local currency rate of this token. Used to show the user the net worth of their holdings.

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC20tokenContractAddressSSSgvp":{"name":"tokenContractAddress","abstract":"

In the case of FA1.2 or higher, we need to know the KT1 address for the token so we can fetch balances and make trades. (should be empty for xtz).

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC7tokenIdSo9NSDecimalaSgvp":{"name":"tokenId","abstract":"

Each token type on a contract will have a unique token_id

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC8isHiddenSbvp":{"name":"isHidden","abstract":"

Recording if the user has marked the token as hidden

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC18favouriteSortIndexSiSgvp":{"name":"favouriteSortIndex","abstract":"

Recording if the position the index the user chose for the favourite token to appear

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4nftsSayAA3NFTVGSgvp":{"name":"nfts","abstract":"

The individual NFT’s owned of this token type

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC11mintingToolSSSgvp":{"name":"mintingTool","abstract":"

The URL of the tool used to mint the item

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC11isFavouriteSbvp":{"name":"isFavourite","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4name6symbol9tokenType9faVersion7balance12thumbnailURL0G15ContractAddress0G2Id4nfts11mintingToolACSSSg_SSAC0dH0OAA02FaJ0OSgAA0D6AmountC10Foundation0M0VSgANSo9NSDecimalaSgSayAA3NFTVGSgANtcfc":{"name":"init(name:symbol:tokenType:faVersion:balance:thumbnailURL:tokenContractAddress:tokenId:nfts:mintingTool:)","abstract":"

Init a Token object that will hold all the necessary data to interact with the Tezos network, and the Dexter exchange

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4from03andD6AmountAcA011TzKTBalanceD0V_AA0dG0Ctcfc":{"name":"init(from:andTokenAmount:)","abstract":"

Init a Token from an object returned by the TzKT API

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4fromAcA17TzKTTokenTransferV_tcfc":{"name":"init(from:)","abstract":"

Init a Token from an object returned by the TzKT API

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC3xtzACyFZ":{"name":"xtz()","abstract":"

Create a Token object with all the settings needed for XTZ

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC3xtz10withAmountAcA0dG0C_tFZ":{"name":"xtz(withAmount:)","abstract":"

Create a Token object with all the settings needed for XTZ, with an initial amount. Useful for setting fees.

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC11placeholder7fromNFT6amount12thumbnailURLAcA0G0V_AA0D6AmountC10Foundation0J0VSgtFZ":{"name":"placeholder(fromNFT:amount:thumbnailURL:)","abstract":"

Useful for creating placeholders for pending activity items

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC11descriptionSSvp":{"name":"description","abstract":"

Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC5isXTZSbyF":{"name":"isXTZ()","abstract":"

Helper function to check if the Token instance being passed aroun is pointing to XTZ. As many functions will require different functionality for fa token versus XTZ

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable to enable working with UITableViewDiffableDataSource

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC2idSSvp":{"name":"id","abstract":"

Conforming to Identifiable to enable working with ForEach and similiar looping functions","parent_name":"Token"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC4typeAA0E4TypeOvp":{"name":"type","abstract":"

enum used to differientate wallet class types. Needed for applications that allow users to create many different types of wallets

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC7addressSSvp":{"name":"address","abstract":"

The TZ1 or TZ2 address of the wallet

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC10privateKey0a6CryptoC007PrivateG0Vvp":{"name":"privateKey","abstract":"

An object representing the PrivateKey used to generate the wallet

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC9publicKey0a6CryptoC006PublicG0Vvp":{"name":"publicKey","abstract":"

An object representing the PublicKey used to generate the wallet address

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC8mnemonic0a6CryptoC08MnemonicVSgvp":{"name":"mnemonic","abstract":"

Optional Bip39 mnemonic used to generate the wallet

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC25secp256k1WithBase58String4typeACSgSS_AA0E4TypeOtcfc":{"name":"init(secp256k1WithBase58String:type:)","abstract":"

Attempt to create an instance of a RegularWallet from an encoded string containing a private key

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC12withMnemonic10passphraseACSg0a6CryptoC00G0V_SStcfc":{"name":"init(withMnemonic:passphrase:)","abstract":"

Create a RegularWallet by supplying a Mnemonic and a passphrase (or “” if none).

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC18withMnemonicLength10passphraseACSg0a6CryptoC00G0V13NumberOfWordsO_SStcfc":{"name":"init(withMnemonicLength:passphrase:)","abstract":"

Create a RegularWallet by asking for a mnemonic of a given number of words and a passphrase (or “” if none).

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC4sign_11isOperation10completionySS_Sbys6ResultOySays5UInt8VGAA0A5ErrorVGctF":{"name":"sign(_:isOperation:completion:)","abstract":"

Sign a hex payload with the private key

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC15privateKeyCurve0a6CryptoC0010EllipticalH0OyF":{"name":"privateKeyCurve()","abstract":"

Return the curve used to create the key

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC22publicKeyBase58encodedSSyF":{"name":"publicKeyBase58encoded()","abstract":"

Get a Base58 encoded version of the public key, in order to reveal the address on the network

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"RegularWallet"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC8endpointSSvp":{"name":"endpoint","abstract":"

The endpoint that will be added onto the TezosNodeConfig.primaryNodeURL to form a full URL for the request

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC7payload10Foundation4DataVSgvp":{"name":"payload","abstract":"

An optional payload for sending HTTP POST requests

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC12responseTypexmvp":{"name":"responseType","abstract":"

The expected response type from the network

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC6isPostSbvp":{"name":"isPost","abstract":"

Computed property to indicate wheter or not this is a POST request

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC8endpoint7payload12responseTypeACyxGSS_10Foundation4DataVSgxmtcfc":{"name":"init(endpoint:payload:responseType:)","abstract":"

Init an RPC object, to be passed to the network layer to performa request to the node.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC15encodableToData0E010Foundation0G0VSgqd___tSERd__lFZ":{"name":"encodableToData(encodable:)","abstract":"

Helper function to wrap up JSONEncoder().encode and log any errors.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE10xtzBalance10forAddressACySSGSS_tFZ":{"name":"xtzBalance(forAddress:)","abstract":"

Creates an RPC to fetch an XTZ balance for a given Address

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE11getDelegate10forAddressACySSGSS_tFZ":{"name":"getDelegate(forAddress:)","abstract":"

Creates an RPC to fetch a deelgate for a given Address

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE10managerKey10forAddressACySSSgGSS_tFZ":{"name":"managerKey(forAddress:)","abstract":"

Creates an RPC to fetch the managerKey for a given Address

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE7counter10forAddressACySSGSS_tFZ":{"name":"counter(forAddress:)","abstract":"

Creates an RPC to fetch the current counter for a given Address

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE5forge16operationPayloadACySSGSgAA09OperationG0V_tFZ":{"name":"forge(operationPayload:)","abstract":"

Creates an RPC to remotely forge an operation

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE6inject11signedBytesACySSGSgSS_tFZ":{"name":"inject(signedBytes:)","abstract":"

Creates an RPC to inject an operation

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A14BlockchainHeadVRszrlE010blockchainF0ACyAEGyFZ":{"name":"blockchainHead()","abstract":"

Creates an RPC to fetch the HEAD of the blockchain and parse it into an object to extract the pieces we are interested in.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A14BlockchainHeadVRszrlE010blockchainF6Minus3ACyAEGyFZ":{"name":"blockchainHeadMinus3()","abstract":"

Creates an RPC to fetch the HEAD of 3 blocks previous and parse it into an object to extract the pieces we are interested in.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A14NetworkVersionVRszrlE07networkF0ACyAEGyFZ":{"name":"networkVersion()","abstract":"

Creates an RPC to fetch the details about the version of the network running on the given server.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A16NetworkConstantsVRszrlE07networkF0ACyAEGyFZ":{"name":"networkConstants()","abstract":"

Creates an RPC to fetch the network constants for the given server, such as how much mutez it costs per byte of storage, or the maximum allowed gas amount

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASayAA16OperationPayloadVGRszrlE5parse11hashToParse8metadataACyAFGSgSS_AA0E8MetadataVtFZ":{"name":"parse(hashToParse:metadata:)","abstract":"

Creates an RPC to remotely parse an operation to verify its contents. Function takes in a hash, as it is returned from the forge call. This function will do all the necessary parsing and formatting

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASayAA17OperationResponseVGRszrlE8preapply16operationPayloadACyAFGSgAA0eI0V_tFZ":{"name":"preapply(operationPayload:)","abstract":"

Creates an RPC to preapply an operation. This OperationPayload must have had its signature and protocol set

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A17OperationResponseVRszrlE03runE00gE7PayloadACyAEGSgAA03RuneH0V_tFZ":{"name":"runOperation(runOperationPayload:)","abstract":"

Creates an RPC to estimate an operation

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAA10Foundation4DataVRszrlE15contractStorage0G7AddressACyAFGSS_tFZ":{"name":"contractStorage(contractAddress:)","abstract":"

Creates an RPC to fetch a contracts Michelson storage

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAA10Foundation4DataVRszrlE6bigMap2idACyAFGSS_tFZ":{"name":"bigMap(id:)","abstract":"

Creates an RPC to fetch the contents of the given big map

","parent_name":"RPC"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC6amountSSvp":{"name":"amount","abstract":"

The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value

","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC11destinationSSvp":{"name":"destination","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC10parametersSDySSypGSgvp":{"name":"parameters","abstract":"

Dictionary holding the entrypoint and value of the contract call

","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC6amount6source11destinationAcA11TokenAmountC_S2Stcfc":{"name":"init(amount:source:destination:)","abstract":"

Create an OperationTransaction, to send an amount of token to a destination

","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC6amount6source11destination10parametersAcA11TokenAmountC_S2SSDySSypGtcfc":{"name":"init(amount:source:destination:parameters:)","abstract":"

Create an OperationTransaction, to invoke a smart contract call

","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationTransaction"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC5levelSivp":{"name":"level","abstract":"

Block level

","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC5nonceSSvp":{"name":"nonce","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC6wallet5level5nonceAcA6Wallet_p_SiSStcfc":{"name":"init(wallet:level:nonce:)","abstract":"

Init with wallet object, block level, and nonce

","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC9publicKeySSvp":{"name":"publicKey","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC6walletAcA6Wallet_p_tcfc":{"name":"init(wallet:)","abstract":"

Create an OperationReveal.

","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC22base58EncodedPublicKey13walletAddressACSS_SStcfc":{"name":"init(base58EncodedPublicKey:walletAddress:)","abstract":"

Create an OperationReveal.

","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationReveal"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC6periodSivp":{"name":"period","abstract":"

The voting period

","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC9proposalsSaySSGvp":{"name":"proposals","abstract":"

List of proposal identifiers

","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC6wallet6period9proposalsAcA6Wallet_p_SiSaySSGtcfc":{"name":"init(wallet:period:proposals:)","abstract":"

Init with wallet, voting period and list of proposal identifiers

","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationProposals"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC7balanceSSvp":{"name":"balance","abstract":"

The initial balance to give to the contract

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC6scriptSDyS2SGvp":{"name":"script","abstract":"

Dictionary holding the code and storage of the contract to create.

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC6source7balance4code7storageACSS_AA9XTZAmountCS2Stcfc":{"name":"init(source:balance:code:storage:)","abstract":"

Create an OperationOrigination.

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationOrigination"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC5levelSivp":{"name":"level","abstract":"

Block level

","parent_name":"OperationEndorsement"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC6wallet5levelAcA6Wallet_p_Sitcfc":{"name":"init(wallet:level:)","abstract":"

Init with wallet and block level

","parent_name":"OperationEndorsement"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationEndorsement"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationEndorsement"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V7ContentV4kindAA0D4KindOvp":{"name":"kind","parent_name":"Content"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V7ContentV5levelSivp":{"name":"level","parent_name":"Content"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V6branchSSvp":{"name":"branch","parent_name":"InlinedEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V10operationsAE7ContentVvp":{"name":"operations","parent_name":"InlinedEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V9signatureSSSgvp":{"name":"signature","parent_name":"InlinedEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html":{"name":"Content","parent_name":"InlinedEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html":{"name":"InlinedEndorsement","abstract":"

Internal struct used to amtch expected struct of data

","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC3op1AC07InlinedF0Vvp":{"name":"op1","abstract":"

The first endorsement

","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC3op2AC07InlinedF0Vvp":{"name":"op2","abstract":"

The second endorsement (should be matching details of first)

","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC6wallet3op13op2AcA6Wallet_p_AC07InlinedF0VAItcfc":{"name":"init(wallet:op1:op2:)","abstract":"

Init with wallet and 2 suspected endorsements

","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC3bh1AA0D11BlockHeaderVvp":{"name":"bh1","abstract":"

The block header of the first baked block

","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC3bh2AA0D11BlockHeaderVvp":{"name":"bh2","abstract":"

The block header of the second baked block

","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC6wallet3bh13bh2AcA6Wallet_p_AA0D11BlockHeaderVAItcfc":{"name":"init(wallet:bh1:bh2:)","abstract":"

Init with wallet and two block headers

","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC8delegateSSSgvp":{"name":"delegate","abstract":"

The baker to delegate too, or nil to undelegate

","parent_name":"OperationDelegation"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC6source8delegateACSS_SSSgtcfc":{"name":"init(source:delegate:)","abstract":"

Create an OperationDelegation.

","parent_name":"OperationDelegation"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationDelegation"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationDelegation"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationDelegation"},"Classes/OperationBallot/Ballot.html#/s:14KukaiCoreSwift15OperationBallotC0E0O3nayyA2EmF":{"name":"nay","parent_name":"Ballot"},"Classes/OperationBallot/Ballot.html#/s:14KukaiCoreSwift15OperationBallotC0E0O3yayyA2EmF":{"name":"yay","parent_name":"Ballot"},"Classes/OperationBallot/Ballot.html#/s:14KukaiCoreSwift15OperationBallotC0E0O4passyA2EmF":{"name":"pass","parent_name":"Ballot"},"Classes/OperationBallot/Ballot.html":{"name":"Ballot","abstract":"

Enum matching the available ballot options

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC6periodSivp":{"name":"period","abstract":"

The voting period

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC8proposalSSvp":{"name":"proposal","abstract":"

The identifier of the proposa;

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC6ballotAC0E0Ovp":{"name":"ballot","abstract":"

The wallet holders vote

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC6wallet6period8proposal6ballotAcA6Wallet_p_SiSSAC0E0Otcfc":{"name":"init(wallet:period:proposal:ballot:)","abstract":"

Init with wallet, period, proposal and ballot

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationBallot"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC9publicKeySSvp":{"name":"publicKey","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC6secretSSvp":{"name":"secret","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC6wallet9andSecretAcA6Wallet_p_SStcfc":{"name":"init(wallet:andSecret:)","abstract":"

Create an OperationActivateAccount.

","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationActivateAccount"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC13operationKindAA0dF0Ovp":{"name":"operationKind","abstract":"

An enum to denote the type of operation. e.g. transaction, delegation, reveal etc.

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC6sourceSSSgvp":{"name":"source","abstract":"

The source address for the operation

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC7counterSSSgvp":{"name":"counter","abstract":"

A string representing a numeric counter. Must be unique and 1 higher than the previous counter. Current counter obtained from the metadata query in TezosNodeClient

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC13operationFeesAA0dF0Vvp":{"name":"operationFees","abstract":"

Object representing the various fees, storage and compute required to fulfil this operation

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC13operationKind6sourceAcA0dF0O_SStcfc":{"name":"init(operationKind:source:)","abstract":"

Create a base operation.

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"Operation"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC4typeAA0E4TypeOvp":{"name":"type","abstract":"

The wallet type, hardcoded to always be WalletType.ledger

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC7addressSSvp":{"name":"address","abstract":"

The TZ address pulled from the Ledger device, cached to avoid complex retrieval when fetching balances etc.

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC9publicKeySSvp":{"name":"publicKey","abstract":"

The raw hex public key extracted from the Ledger, needed in order to perform REVEAL operations

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC14derivationPathSSvp":{"name":"derivationPath","abstract":"

The derivation path used to fetch the address and public key

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC5curve0a6CryptoC015EllipticalCurveOvp":{"name":"curve","abstract":"

The elliptical curve used to fetch the address and public key

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC10ledgerUUIDSSvp":{"name":"ledgerUUID","abstract":"

The unique ledger UUID, that corresponds to this wallet address

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC7address9publicKey14derivationPath5curve10ledgerUUIDACSgSS_S2S0a6CryptoC015EllipticalCurveOSStcfc":{"name":"init(address:publicKey:derivationPath:curve:ledgerUUID:)","abstract":"

Create an instance of a LedgerWallet. Can return nil if invalid public key supplied

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC4sign_11isOperation10completionySS_Sbys6ResultOySays5UInt8VGAA0A5ErrorVGctF":{"name":"sign(_:isOperation:completion:)","abstract":"

Sign a hex string.","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC15privateKeyCurve0a6CryptoC0010EllipticalH0OyF":{"name":"privateKeyCurve()","abstract":"

Function to extract the curve used to create the public key

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC22publicKeyBase58encodedSSyF":{"name":"publicKeyBase58encoded()","abstract":"

Function to convert the public key into a Base58 encoded string

","parent_name":"LedgerWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC4typeAA10WalletTypeOvp":{"name":"type","abstract":"

The underlying wallet type, set to .hd

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC7addressSSvp":{"name":"address","abstract":"

The public TZ1 address of the wallet

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC10privateKey0a6CryptoC007PrivateF0Vvp":{"name":"privateKey","abstract":"

An WalletCore object representing the PrivateKey used to generate the wallet

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC9publicKey0a6CryptoC006PublicF0Vvp":{"name":"publicKey","abstract":"

An WalletCore object representing the PublicKey used to generate the wallet address

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC8mnemonic0a6CryptoC08MnemonicVvp":{"name":"mnemonic","abstract":"

The Bip39 mnemonic used to generate the wallet

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC14derivationPathSSvp":{"name":"derivationPath","abstract":"

The Bip44 derivationPath used to create the wallet

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC12withMnemonic10passphrase14derivationPathACSg0a6CryptoC00F0V_S2Stcfc":{"name":"init(withMnemonic:passphrase:derivationPath:)","abstract":"

Create a HDWallet by supplying a mnemonic string and a passphrase (or “” if none).

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC18withMnemonicLength10passphrase14derivationPathACSg0a6CryptoC00F0V13NumberOfWordsO_S2Stcfc":{"name":"init(withMnemonicLength:passphrase:derivationPath:)","abstract":"

Create a HDWallet by asking for a mnemonic of a given number of words and a passphrase (or “” if none).

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC4sign_11isOperation10completionySS_Sbys6ResultOySays5UInt8VGAA0A5ErrorVGctF":{"name":"sign(_:isOperation:completion:)","abstract":"

Sign a hex payload with the private key

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC15privateKeyCurve0a6CryptoC0010EllipticalG0OyF":{"name":"privateKeyCurve()","abstract":"

Return the curve used to create the key

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC22publicKeyBase58encodedSSyF":{"name":"publicKeyBase58encoded()","abstract":"

Get a Base58 encoded version of the public key, in order to reveal the address on the network

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC11createChild12accountIndexACSgSi_tF":{"name":"createChild(accountIndex:)","abstract":"

The default implementation in Ledger is to not give users the option to provide their own derivation path, but instead increment the “account” field by 1 each time.","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC11createChild14derivationPathACSgSS_tF":{"name":"createChild(derivationPath:)","abstract":"

This function will create a new HDWallet, by using the same key combined with the supplied derivationPath

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"HDWallet"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC8contractSSvp":{"name":"contract","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC7networkSSvp":{"name":"network","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC8token_idSivp":{"name":"token_id","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC6symbolSSSgvp":{"name":"symbol","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC4nameSSSgvp":{"name":"name","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC8decimalsSivp":{"name":"decimals","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC9faVersionAA02FaJ0OSgvp":{"name":"faVersion","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC8imageURL10Foundation0J0VSgvp":{"name":"imageURL","parent_name":"BetterCallDevTokenMetadata"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV33tokenIdAndAmountFromSendMichelson9michelsonSS03rpcJ0_So9NSDecimalaSg0gH0SS11destinationtSgyp_tFZ":{"name":"tokenIdAndAmountFromSendMichelson(michelson:)","abstract":"

Extract rpc amount (without decimal info) a tokenId, and the destination from a michelson FA1.2 / FA2 transfer payload

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV18faTokenDetailsFrom11transactionSS13tokenContract_SS9rpcAmountSo9NSDecimalaSg0L2IdSS11destinationtSgAA0D11TransactionC_tFZ":{"name":"faTokenDetailsFrom(transaction:)","abstract":"

Extract details from a payload in order to present to the user what it is they are trying to send

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV18faTokenDetailsFrom10operationsSS13tokenContract_SS9rpcAmountSo9NSDecimalaSg0L2IdSS11destinationtSgSayAA0D0CG_tFZ":{"name":"faTokenDetailsFrom(operations:)","abstract":"

Helper to call faTokenDetailsFrom(transaction: OperationTransaction) on the first OperationTransaction in an array of operations. Allows to more easily parse an array of operations that may include approval‘s or update_operator calls

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV13isTezTransfer10operationsSbSayAA0D0CG_tFZ":{"name":"isTezTransfer(operations:)","abstract":"

Return true if

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV023firstTransferEntrypointD010operationsAA0D11TransactionCSgSayAA0D0CG_tFZ":{"name":"firstTransferEntrypointOperation(operations:)","abstract":"

Easy way to extract the first non-approval or update_operator transaction

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV14isContractCall10operationsSS10entrypoint_SS7addresstSgSayAA0D0CG_tFZ":{"name":"isContractCall(operations:)","abstract":"

Return the entrypoint and address of the first operation, that doesn’t equal approve, update_operator or transfer

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV017firstContractCallD010operationsAA0D11TransactionCSgSayAA0D0CG_tFZ":{"name":"firstContractCallOperation(operations:)","abstract":"

Return the first operation where entrypoint doesn’t equal approve, update_operator or transfer

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV29totalXTZAmountForContractCall10operationsAA0H0CSayAA0D0CG_tFZ":{"name":"totalXTZAmountForContractCall(operations:)","abstract":"

Run through list of operations and extract .amount from any OperationTransaction

","parent_name":"Extractor"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC04sendD0_2of4from2toSayAA0D0CGAA11TokenAmountC_AA0J0CS2StFZ":{"name":"sendOperation(_:of:from:to:)","abstract":"

Create the operations necessary to send an amount of a token to a destination address.

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC04sendD0_5ofNft4from2toSayAA0D0CGSo9NSDecimala_AA3NFTVS2StFZ":{"name":"sendOperation(_:ofNft:from:to:)","abstract":"

Create the operations necessary to send aan NFT

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC08delegateD02to4fromSayAA0D0CGSS_SStFZ":{"name":"delegateOperation(to:from:)","abstract":"

Create the operations necessary to delegate funds to a baker.

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC010undelegateD07addressSayAA0D0CGSS_tFZ":{"name":"undelegateOperation(address:)","abstract":"

Create the operations necessary to remove the current delegate from an address.

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC14swapXtzToToken7withDex9xtzAmount03miniM013walletAddress7timeoutSayAA0D0CGAA14DipDupExchangeV_AA9XTZAmountCAA0iM0CSSSdtFZ":{"name":"swapXtzToToken(withDex:xtzAmount:minTokenAmount:walletAddress:timeout:)","abstract":"

Create the operations necessary to perform an exchange of XTZ for a given FA token, using a given dex

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC14swapTokenToXTZ7withDex11tokenAmount12minXTZAmount13walletAddress7timeoutSayAA0D0CGAA14DipDupExchangeV_AA0gM0CAA0O0CSSSdtFZ":{"name":"swapTokenToXTZ(withDex:tokenAmount:minXTZAmount:walletAddress:timeout:)","abstract":"

Create the operations necessary to perform an exchange of a given FA token for XTZ, using dex contracts

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC07approveD012tokenAddress07spenderH09allowance06walletH0AA0D0CSS_SSAA11TokenAmountCSStFZ":{"name":"approveOperation(tokenAddress:spenderAddress:allowance:walletAddress:)","abstract":"

Create an operation to call the entrypoint approve, to allow another address to spend some of your token (only FA1.2)","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC015updateOperatorsD012tokenAddress07spenderI09allowance06walletI0AA0D0CSS_SSAA11TokenAmountCSStFZ":{"name":"updateOperatorsOperation(tokenAddress:spenderAddress:allowance:walletAddress:)","abstract":"

Create an operation to call the entrypoint update_operators, to allow another address to spend some of your token (only FA2)","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC09allowanceD08standard12tokenAddress07spenderI00F006walletI0AA0D0CAA19DipDupTokenStandardO_S2SAA0N6AmountCSStFZ":{"name":"allowanceOperation(standard:tokenAddress:spenderAddress:allowance:walletAddress:)","abstract":"

Return the operation necessary to register an allowance (either calling apporve or update_operators) depending on the token standard version. Removing the need to check manually","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC12addLiquidity7withDex3xtz5token11minLiquidty09isInitialG013walletAddress7timeoutSayAA0D0CGAA14DipDupExchangeV_AA9XTZAmountCAA11TokenAmountCATSbSSSdtFZ":{"name":"addLiquidity(withDex:xtz:token:minLiquidty:isInitialLiquidity:walletAddress:timeout:)","abstract":"

Create the operations necessary to add liquidity to a dex contract. Use DexCalculationService to figure out the numbers required

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC15removeLiquidity7withDex6minXTZ0J5Token15liquidityToBurn13walletAddress7timeoutSayAA0D0CGAA14DipDupExchangeV_AA9XTZAmountCAA0L6AmountCASSSSdtFZ":{"name":"removeLiquidity(withDex:minXTZ:minToken:liquidityToBurn:walletAddress:timeout:)","abstract":"

Create the operations necessary to remove liquidity from a dex contract, also withdraw pending rewards if applicable. Use DexCalculationService to figure out the numbers required

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC15withdrawRewards7withDex13walletAddressSayAA0D0CGAA14DipDupExchangeV_SStFZ":{"name":"withdrawRewards(withDex:walletAddress:)","abstract":"

Create the operations necessary to withdraw rewards from a dex contract. For example in quipuswap, XTZ provided as liquidity will earn baking rewards. This can been withdrawn at any time while leaving liquidity in palce

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC16operationPayload12fromMetadata13andOperations13walletAddress22base58EncodedPublicKeyAA0dG0VAA0dI0V_SayAA0D0CGS2StFZ":{"name":"operationPayload(fromMetadata:andOperations:walletAddress:base58EncodedPublicKey:)","abstract":"

Convert an array of operations into the format expected by the RPC. Will also inject a OperationReveal if the sender has not yet revealed their public key.

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC27createDexterTimestampString19nowPlusTimeIntervalSSSd_tFZ":{"name":"createDexterTimestampString(nowPlusTimeInterval:)","abstract":"

Dexter requires date strings to act as deadline dates for exchanges.","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC18sendTokenMichelson12forFaVersion11tokenAmount0L2Id2to4fromSDySSypGAA0jK0O_AA0gM0CSo9NSDecimalaS2StFZ":{"name":"sendTokenMichelson(forFaVersion:tokenAmount:tokenId:to:from:)","parent_name":"OperationFactory"},"Classes/OperationFactory/Extractor.html":{"name":"Extractor","abstract":"

Internal Struct to encapsulate helpers methods needed to extract critical information from an array of operations, needed for processing decisions like “do i display a send token screen, or a send NFt screen”, fetching total XTZ sent in 1 action etc

","parent_name":"OperationFactory"},"Classes/TzKTClient/Constants.html#/s:14KukaiCoreSwift10TzKTClientC9ConstantsV21tokenBalanceQuerySizeSivpZ":{"name":"tokenBalanceQuerySize","parent_name":"Constants"},"Classes/TzKTClient/TzKTServiceError.html#/s:14KukaiCoreSwift10TzKTClientC0D14KTServiceErrorO10invalidURLyA2EmF":{"name":"invalidURL","parent_name":"TzKTServiceError"},"Classes/TzKTClient/TzKTServiceError.html#/s:14KukaiCoreSwift10TzKTClientC0D14KTServiceErrorO05parseG0yAESScAEmF":{"name":"parseError(_:)","parent_name":"TzKTServiceError"},"Classes/TzKTClient/TzKTServiceError.html":{"name":"TzKTServiceError","abstract":"

Unique Errors that TzKTClient can throw

","parent_name":"TzKTClient"},"Classes/TzKTClient/Constants.html":{"name":"Constants","abstract":"

Constants needed for interacting with the API

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC11isListeningSbvp":{"name":"isListening","abstract":"

Is currently monitoring an address for update notifications

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC16accountDidChangeSaySSGvp":{"name":"accountDidChange","abstract":"

Notifications of monitored addresses that have changed

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC14networkService6config19betterCallDevClient06dipDupL0AcA07NetworkG0C_AA09TezosNodeL6ConfigVAA06BetterjkL0CAA03DipnL0Ctcfc":{"name":"init(networkService:config:betterCallDevClient:dipDupClient:)","abstract":"

Init a TzKTClient with a NetworkService and a TezosNodeClientConfig and a BetterCallDevClient.

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC10getStorage11forContract6ofType10completionySS_xmys6ResultOyxAA0A5ErrorVGctSeRzSERzlF":{"name":"getStorage(forContract:ofType:completion:)","abstract":"

Get the storage of a given contract and parse it to a supplied model type

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC9getBigMap5forId6ofType10completionySS_xmys6ResultOyxAA0A5ErrorVGctSeRzSERzlF":{"name":"getBigMap(forId:ofType:completion:)","abstract":"

Get the keys of a big map, by ID and parse it to a model

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC12getBigMapKey5forId3key6ofType10completionySS_SSxmys6ResultOyxAA0A5ErrorVGctSeRzSERzlF":{"name":"getBigMapKey(forId:key:ofType:completion:)","abstract":"

Get the keys of a big map, but filtered to only one specific key. Parse the response as the supplied model

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC14suggestAccount9forString10completionySS_ys6ResultOyAA0D9KTAddressVSgAA0A5ErrorVGctF":{"name":"suggestAccount(forString:completion:)","abstract":"

Call https://api.tzkt.io/v1/suggest/accounts/… appending the supplied string, in an attempt to search for an account with a known alias

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC6bakers10completionyys6ResultOySayAA0D7KTBakerVGAA0A5ErrorVGc_tF":{"name":"bakers(completion:)","abstract":"

Call https://api.baking-bad.org/v2/bakers/ for a list of public bakers if on mainnet, else search for all accounts self delegating on testnet

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC11bakerConfig10forAddress10completionySS_ys6ResultOyAA0D7KTBakerVAA0A5ErrorVGctF":{"name":"bakerConfig(forAddress:completion:)","abstract":"

Call https://api.baking-bad.org/v2/bakers/…?configs=true to get the config settings for the given baker

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC16delegatorRewards10forAddress5limit10completionySS_Siys6ResultOySayAA0D17KTDelegatorRewardVGAA0A5ErrorVGctF":{"name":"delegatorRewards(forAddress:limit:completion:)","abstract":"

Call https://api.tzkt.io/v1/rewards/delegators/…?limit=… to get the config settings for the given baker

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC25estimateLastAndNextReward10forAddress8delegate10completionySS_AA0D17KTAccountDelegateVys6ResultOyAA09AggregateJ11InformationVAA0A5ErrorVGctF":{"name":"estimateLastAndNextReward(forAddress:delegate:completion:)","abstract":"

Make many different calls to attempt to figure out the previous reward the user should have received, and the next potential reward

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC13getLastReward10forAddress12uniqueBakers15payoutAddresses10completionySS_SayAA0D9KTAddressVGSDySSAJGys6ResultOySayAA0D13KTTransactionVGAA0A5ErrorVGctF":{"name":"getLastReward(forAddress:uniqueBakers:payoutAddresses:completion:)","abstract":"

Take all the baker addresses and payout addresses and find the last transaction (if any) received from any of them

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC6cycles5limit10completionySi_ys6ResultOySayAA0D7KTCycleVGAA0A5ErrorVGctF":{"name":"cycles(limit:completion:)","abstract":"

Call https://api.tzkt.io/v1/cycles?limit=… to get the 10 most recent cycles

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC13cycleForLevel6cycles5levelAA0D7KTCycleVSgSayAHG_So9NSDecimalatF":{"name":"cycleForLevel(cycles:level:)","abstract":"

Given a list of cycles, search through them to find what cycle a given block level appeared in","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC12getOperation6byHash10completionySS_ySayAA0D11KTOperationVGSg_AA0A5ErrorVSgtctF":{"name":"getOperation(byHash:completion:)","abstract":"

Query details about the given operation

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC23listenForAccountChanges9addresses13withDebuggingySaySSG_SbtF":{"name":"listenForAccountChanges(addresses:withDebugging:)","abstract":"

Open a websocket connection to request a notification for any changes to the given account. The @Published var accountDidChange will be notified if something occurs

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC30stopListeningForAccountChangesyyF":{"name":"stopListeningForAccountChanges()","abstract":"

Close the websocket from listenForAccountChanges

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC31changeAddressToListenForChanges9addressesySaySSG_tF":{"name":"changeAddressToListenForChanges(addresses:)","abstract":"

Close the current connection and open another

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC15getBalanceCount10forAddress10completionySS_ys6ResultOySiAA0A5ErrorVGctF":{"name":"getBalanceCount(forAddress:completion:)","abstract":"

Get the count of tokens the given address has balances for (excluding zero balances)

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC14getBalancePage10forAddress6offset10completionySS_Siys6ResultOySayAA0D9KTBalanceVGAA0A5ErrorVGctF":{"name":"getBalancePage(forAddress:offset:completion:)","abstract":"

Tokens balances and metadata need to be fetch from a paginated API. THis function calls a sinlerequest or 1 page of balances / metadata

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC10getAccount10forAddress10completionySS_ys6ResultOyAA0D9KTAccountVAA0A5ErrorVGctF":{"name":"getAccount(forAddress:completion:)","abstract":"

Get the account object from TzKT caontaining information about the address, its balance and baker

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC14getAllBalances10forAddress10completionySS_ys6ResultOyAA7AccountVAA0A5ErrorVGctF":{"name":"getAllBalances(forAddress:completion:)","abstract":"

Get all balances from one function call, by fetching the result from getBalanceCount and using that to decide how many pages should be called

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC9avatarURL8forToken10Foundation0G0VSgSS_tFZ":{"name":"avatarURL(forToken:)","abstract":"

In order to access the cached images, you need the URL it was downloaded from. This can either be found inside the Token objects returned as part of Account from the fetchAccountInfo func.","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC17fetchTransactions10forAddress5limit10completionySS_SiySayAA0D13KTTransactionVGctF":{"name":"fetchTransactions(forAddress:limit:completion:)","abstract":"

Fetch all transactions, both account operations, and token transfers, and combine them into 1 response

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC17groupTransactions12transactions20currentWalletAddressSayAA0D18KTTransactionGroupVGSayAA0dL0VG_SStF":{"name":"groupTransactions(transactions:currentWalletAddress:)","abstract":"

Group transactions into logical groups, so user doesn’t see N enteries for 1 contract call resulting in many internal operations

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:13SignalRClient21HubConnectionDelegateP17connectionDidOpen03hubD0yAA0cD0C_tF":{"name":"connectionDidOpen(hubConnection:)","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:13SignalRClient21HubConnectionDelegateP18connectionDidClose5errorys5Error_pSg_tF":{"name":"connectionDidClose(error:)","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:13SignalRClient21HubConnectionDelegateP23connectionDidFailToOpen5errorys5Error_p_tF":{"name":"connectionDidFailToOpen(error:)","parent_name":"TzKTClient"},"Classes/TezosNodeClient/TezosNodeClientError.html#/s:14KukaiCoreSwift15TezosNodeClientC0deF5ErrorO28noDexterExchangeAddressFoundyA2EmF":{"name":"noDexterExchangeAddressFound","parent_name":"TezosNodeClientError"},"Classes/TezosNodeClient/TezosNodeClientError.html#/s:14KukaiCoreSwift15TezosNodeClientC0deF5ErrorO16michelsonParsingyA2EmF":{"name":"michelsonParsing","parent_name":"TezosNodeClientError"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC6configAA0deF6ConfigVvp":{"name":"config","abstract":"

The configuration object containing all the necessary settings to connect and communicate with the Tezos node

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC14networkServiceAA07NetworkH0Cvp":{"name":"networkService","abstract":"

The NetworkService object that will perform all the networking calls

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC16operationServiceAA09OperationH0Cvp":{"name":"operationService","abstract":"

The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC19feeEstimatorServiceAA03FeehI0Cvp":{"name":"feeEstimatorService","abstract":"

The service responsible for calculating network fees on behalf of the user

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC14networkVersionAA07NetworkH0VSgvp":{"name":"networkVersion","abstract":"

Available information about the version of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC16networkConstantsAA07NetworkH0VSgvp":{"name":"networkConstants","abstract":"

Available information about the constants of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient/TezosNodeClientError.html":{"name":"TezosNodeClientError","abstract":"

Types of errors

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC6configAcA0deF6ConfigV_tcfc":{"name":"init(config:)","abstract":"

Init a TezosNodeClient with a TezosNodeClientConfig.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC10getBalance10forAddress10completionySS_ys6ResultOyAA9XTZAmountCAA0A5ErrorVGctF":{"name":"getBalance(forAddress:completion:)","abstract":"

Gets the xtz balance for a given Address.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC11getDelegate10forAddress10completionySS_ys6ResultOySSAA0A5ErrorVGctF":{"name":"getDelegate(forAddress:completion:)","abstract":"

Gets the delegate for the given address.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC8estimate10operations13walletAddress22base58EncodedPublicKey10completionySayAA9OperationCG_S2Sys6ResultOyAA19FeeEstimatorServiceC010EstimationQ0VAA0A5ErrorVGctF":{"name":"estimate(operations:walletAddress:base58EncodedPublicKey:completion:)","abstract":"

Take an array of operations and estimate the gas, storage, baker fee and burn fees required to inject it onto the network","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC4send10operations10withWallet10completionySayAA9OperationCG_AA0J0_pys6ResultOySSAA0A5ErrorVGctF":{"name":"send(operations:withWallet:completion:)","abstract":"

Send an array of Operation‘s to the blockchain. Use OperationFactory to help create this array for common use cases.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC4send16operationPayload0H8Metadata10withWallet10completionyAA09OperationI0V_AA0nJ0VAA0L0_pys6ResultOySSAA0A5ErrorVGctF":{"name":"send(operationPayload:operationMetadata:withWallet:completion:)","abstract":"

Send an already contrsutructed OperationPayload with the necessary OperationMetadata without having to fetch metadata again.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC20getOperationMetadata16forWalletAddress10completionySS_ys6ResultOyAA0hI0VAA0A5ErrorVGctF":{"name":"getOperationMetadata(forWalletAddress:completion:)","abstract":"

Get all the metadata necessary from the network to perform operations.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC18getContractStorage15contractAddress10completionySS_ys6ResultOySDySSypGAA0A5ErrorVGctF":{"name":"getContractStorage(contractAddress:completion:)","abstract":"

Get the Michelson storage of a given contract from the blockchain.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC9getBigMap2id10completionySS_ys6ResultOySDySSypGAA0A5ErrorVGctF":{"name":"getBigMap(id:completion:)","abstract":"

Get the Michelson big map contents, from a given id

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC21getNetworkInformation10completionyySb_AA0A5ErrorVSgtc_tF":{"name":"getNetworkInformation(completion:)","abstract":"

Query the server for the NetworkVersion and NetworkConstants, and store the responses in the tezosNodeClient properties networkVersion and networkConstants,","parent_name":"TezosNodeClient"},"Classes/TezosDomainsClient/BothNetworkReverseRecord.html#/s:14KukaiCoreSwift18TezosDomainsClientC24BothNetworkReverseRecordV7mainnetAA0deiJ0VSgvp":{"name":"mainnet","parent_name":"BothNetworkReverseRecord"},"Classes/TezosDomainsClient/BothNetworkReverseRecord.html#/s:14KukaiCoreSwift18TezosDomainsClientC24BothNetworkReverseRecordV8ghostnetAA0deiJ0VSgvp":{"name":"ghostnet","parent_name":"BothNetworkReverseRecord"},"Classes/TezosDomainsClient/BothNetworkReverseRecord.html#/s:14KukaiCoreSwift18TezosDomainsClientC24BothNetworkReverseRecordV7mainnet8ghostnetAeA0deiJ0VSg_AJtcfc":{"name":"init(mainnet:ghostnet:)","parent_name":"BothNetworkReverseRecord"},"Classes/TezosDomainsClient/BothNetworkReverseRecord.html":{"name":"BothNetworkReverseRecord","abstract":"

Object to wrap up a response fomr both networks

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC14networkService6configAcA07NetworkH0C_AA0d4NodeF6ConfigVtcfc":{"name":"init(networkService:config:)","abstract":"

Init a TezosDomainsClient with a NetworkService and a TezosNodeClientConfig.

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC12getDomainFor7address3url10completionySS_10Foundation3URLVSgys6ResultOyAA15GraphQLResponseVyAA0deH8ResponseVGAA0A5ErrorVGctF":{"name":"getDomainFor(address:url:completion:)","abstract":"

Get Tezos domain response for a given address

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC24getMainAndGhostDomainFor7address10completionySS_ys6ResultOyAC24BothNetworkReverseRecordVAA0A5ErrorVGctF":{"name":"getMainAndGhostDomainFor(address:completion:)","abstract":"

Query both mainnet and ghostnet versions of Tezos domains to find all records for the given address

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC13getAddressFor6domain10completionySS_ys6ResultOyAA15GraphQLResponseVyAA0deH8ResponseVGAA0A5ErrorVGctF":{"name":"getAddressFor(domain:completion:)","abstract":"

Find the tz address of a given domain

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC03getE3For9addresses3url10completionySaySSG_10Foundation3URLVSgys6ResultOyAA15GraphQLResponseVyAA0dE18DomainBulkResponseVGAA0A5ErrorVGctF":{"name":"getDomainsFor(addresses:url:completion:)","abstract":"

Bulk function for fetching domains for an array of addresses

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC015getMainAndGhostE3For9addresses10completionySaySSG_ys6ResultOySDySSAC24BothNetworkReverseRecordVGAA0A5ErrorVGctF":{"name":"getMainAndGhostDomainsFor(addresses:completion:)","abstract":"

Bulk function for fetching domains for an array of addresses, check ghostnet and mainnet for each

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC15getAddressesFor7domains10completionySaySSG_ys6ResultOyAA15GraphQLResponseVyAA0dE19AddressBulkResponseVGAA0A5ErrorVGctF":{"name":"getAddressesFor(domains:completion:)","abstract":"

Bulk function to find all domains for a list of addresses

","parent_name":"TezosDomainsClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC11collectionsSDySSAA0D10CollectionVGvp":{"name":"collections","abstract":"

Cached metadata of NFT collections, e.g. name, thumbnailURL etc

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC6tokensSDySSAA0D12TokenReponseVGvp":{"name":"tokens","abstract":"

Cached metadata of specific tokens, e.g. prices, offers etc

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC14networkService6configAcA07NetworkG0C_AA09TezosNodeE6ConfigVtcfc":{"name":"init(networkService:config:)","abstract":"

Init a ObjktClient with a NetworkService and a TezosNodeClientConfig.

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC21unresolvedCollections9addressesSaySSGAF_tF":{"name":"unresolvedCollections(addresses:)","abstract":"

Take in an array of contract addresses, and return a list of the ones that we currently have no metadata for

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC21resolveCollectionsAll9addresses10completionySaySSG_ys6ResultOySbAA0A5ErrorVGctF":{"name":"resolveCollectionsAll(addresses:completion:)","abstract":"

Search OBJKT to find metadata on the list of addresses provided

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC22resolveCollectionsPage9addresses10completionys10ArraySliceVySSG_ys6ResultOyAA15GraphQLResponseVyAA0dG0VGAA0A5ErrorVGctF":{"name":"resolveCollectionsPage(addresses:completion:)","abstract":"

Find the metadata of a list of contracts, used recurrisvely to find all collections while limited to request query size

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC12resolveToken7address7tokenId21forOwnerWalletAddress10completionySS_So9NSDecimalaSSys6ResultOyAA15GraphQLResponseVyAA0dG7ReponseVGAA0A5ErrorVGctF":{"name":"resolveToken(address:tokenId:forOwnerWalletAddress:completion:)","abstract":"

Find the meatdata of a specific token

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC13tokenResponse10forAddress0F2IdAA0D12TokenReponseVSgSS_SitF":{"name":"tokenResponse(forAddress:tokenId:)","abstract":"

Helper to fetch a specific token metadata from the cache

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC11deleteCacheyyF":{"name":"deleteCache()","abstract":"

Clear all the cached data

","parent_name":"ObjktClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC15dexMaxQuerySizeSivpZ":{"name":"dexMaxQuerySize","abstract":"

Max enteries to return per request

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC14networkService6configAcA07NetworkH0C_AA09TezosNodeF6ConfigVtcfc":{"name":"init(networkService:config:)","abstract":"

Init a DipDupClient with a NetworkService and a TezosNodeClientConfig.

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC21getExchangesAndTokens5limit6offset10completionySi_Siys6ResultOyAA15GraphQLResponseVyAA0dehiJ8ResponseVGAA0A5ErrorVGctF":{"name":"getExchangesAndTokens(limit:offset:completion:)","abstract":"

Get a list of all the tokens available and on what excahnges (including their prices and pool data)

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC24getAllExchangesAndTokens10completionyys6ResultOySayAA0deijK0VGAA0A5ErrorVGc_tF":{"name":"getAllExchangesAndTokens(completion:)","abstract":"

Recurrsively call getExchangesAndTokens(...) until we have found all the tokens

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC15getLiquidityFor7address10completionySS_ys6ResultOyAA15GraphQLResponseVyAA0dE8PositionVGAA0A5ErrorVGctF":{"name":"getLiquidityFor(address:completion:)","abstract":"

Query a given addresses liquidity token balances

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC15getChartDataFor16exchangeContract7nowDate10completionySS_10Foundation0N0Vys6ResultOyAA15GraphQLResponseVyAA0dehI0VGAA0A5ErrorVGctF":{"name":"getChartDataFor(exchangeContract:nowDate:completion:)","abstract":"

Query a given contract address for pricing data for the given token

","parent_name":"DipDupClient"},"Classes/BetterCallDevClient/BetterCallDevClientError.html#/s:14KukaiCoreSwift19BetterCallDevClientC0defG5ErrorO10invalidURLyA2EmF":{"name":"invalidURL","parent_name":"BetterCallDevClientError"},"Classes/BetterCallDevClient/BetterCallDevClientError.html#/s:14KukaiCoreSwift19BetterCallDevClientC0defG5ErrorO05parseH0yAESScAEmF":{"name":"parseError(_:)","parent_name":"BetterCallDevClientError"},"Classes/BetterCallDevClient/BetterCallDevClientError.html":{"name":"BetterCallDevClientError","abstract":"

Dedicated BCD errors

","parent_name":"BetterCallDevClient"},"Classes/BetterCallDevClient.html#/s:14KukaiCoreSwift19BetterCallDevClientC14networkService6configAcA07NetworkI0C_AA09TezosNodeG6ConfigVtcfc":{"name":"init(networkService:config:)","abstract":"

Init a BetterCallDevClient with a NetworkService and a TezosNodeClientConfig.

","parent_name":"BetterCallDevClient"},"Classes/BetterCallDevClient.html#/s:14KukaiCoreSwift19BetterCallDevClientC20getMoreDetailedError6byHash10completionySS_yAA0def9OperationK0VSg_AA0aK0VSgtctF":{"name":"getMoreDetailedError(byHash:completion:)","abstract":"

Primarily the TzKTClient is used to fetch details on operations. However for more complex calls involving smart contracts, TzKT will only return limited error message info.","parent_name":"BetterCallDevClient"},"Classes/BetterCallDevClient.html":{"name":"BetterCallDevClient","abstract":"

BetterCallDev (BCD) is an indexer/smart contract debugging tool, used for the Tezos blockchain."},"Classes/DipDupClient.html":{"name":"DipDupClient","abstract":"

This client exposes functions to allow communication to the indexer platform DipDup ( https://dipdup.net/ )."},"Classes/ObjktClient.html":{"name":"ObjktClient","abstract":"

Client for interacting with the API of the popular NFT marketplace, OBJKT.com"},"Classes/TezosDomainsClient.html":{"name":"TezosDomainsClient","abstract":"

A client class allowing integration with the tezos domains GraphQL API. See more here: https://tezos.domains/

"},"Classes/TezosNodeClient.html":{"name":"TezosNodeClient","abstract":"

The TezosNodeClient offers methods for interacting with the Tezos node to fetch balances, send transactions etc."},"Classes/TzKTClient.html":{"name":"TzKTClient","abstract":"

TzKT is an indexer for Tezos, who’s API allows developers to query details about wallets, transactions, bakers, account status etc

"},"Classes/OperationFactory.html":{"name":"OperationFactory","abstract":"

Class responsible for creating operations necessary to perform a given action, and converting those operations into the single payload expected by the RPC."},"Classes/BetterCallDevTokenMetadata.html":{"name":"BetterCallDevTokenMetadata","abstract":"

A model matching the response that comes back from BetterCallDev’s API: v1/tokens/<network>/metadata?contract=<address>

"},"Classes/HDWallet.html":{"name":"HDWallet","abstract":"

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address."},"Classes/LedgerWallet.html":{"name":"LedgerWallet","abstract":"

A Tezos wallet class, used to cache infomration regarding the paired ledger device used to sign the payload."},"Classes/Operation.html":{"name":"Operation","abstract":"

Base class representing an Operation on the Tezos network. On its own this class can’t be sent to the network. See its subclasses for more info.

"},"Classes/OperationActivateAccount.html":{"name":"OperationActivateAccount","abstract":"

Operation subclass for revealing a publickey to the network.

"},"Classes/OperationBallot.html":{"name":"OperationBallot","abstract":"

Operation to submit a ballot on an upcoming proposal

"},"Classes/OperationDelegation.html":{"name":"OperationDelegation","abstract":"

Operation subclass for delegating an account to a baker

"},"Classes/OperationDoubleBakingEvidence.html":{"name":"OperationDoubleBakingEvidence","abstract":"

Operation to report a baking of baking the same block twice

"},"Classes/OperationDoubleEndorsementEvidence.html":{"name":"OperationDoubleEndorsementEvidence","abstract":"

Operation to report a baker trying to endorse a block twice

"},"Classes/OperationEndorsement.html":{"name":"OperationEndorsement","abstract":"

Operation for endorsing a block

"},"Classes/OperationOrigination.html":{"name":"OperationOrigination","abstract":"

Operation subclass for originating a contract on the Tezos network

"},"Classes/OperationProposals.html":{"name":"OperationProposals"},"Classes/OperationReveal.html":{"name":"OperationReveal","abstract":"

Operation subclass for revealing a publickey to the network.

"},"Classes/OperationSeedNonceRevelation.html":{"name":"OperationSeedNonceRevelation","abstract":"

Operation to reveal seed nonce to blockchain

"},"Classes/OperationTransaction.html":{"name":"OperationTransaction","abstract":"

Operation subclass for sending XTZ to a destination

"},"Classes/RPC.html":{"name":"RPC","abstract":"

A generic class representing an RPC call to the Tezos network."},"Classes/RegularWallet.html":{"name":"RegularWallet","abstract":"

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address."},"Classes/Token.html":{"name":"Token","abstract":"

A class to represent a Token on the Tezos network. This class will do all the heavy lifting of converting values from the RPC to more human readbale values."},"Classes/TokenAmount.html":{"name":"TokenAmount","abstract":"

Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length."},"Classes/TorusWallet.html":{"name":"TorusWallet","abstract":"

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address."},"Classes/XTZAmount.html":{"name":"XTZAmount","abstract":"

A subclass of TokenAmount to make it more explict when functions require XTZ (such as network fees)."},"Classes/DAppHelperService.html":{"name":"DAppHelperService","abstract":"

A Helper service to simply combine multiple calls from other services, and/or map to specific responses, in order to expose a piece of functionality provided by a dApp

"},"Classes/DexCalculationService.html":{"name":"DexCalculationService","abstract":"

Wrapper around the kukai-dex-calculations JS library for performing calculations: https://github.com/kukai-wallet/kukai-dex-calculations

"},"Classes/DiskService.html":{"name":"DiskService","abstract":"

A service class to write and read data from the devices documents directory

"},"Classes/ErrorHandlingService.html":{"name":"ErrorHandlingService","abstract":"

A class used to process errors into more readable format, and optionally notifiy a global error handler of every error occuring

"},"Classes/FeeEstimatorService.html":{"name":"FeeEstimatorService","abstract":"

An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker."},"Classes/LedgerService.html":{"name":"LedgerService","abstract":"

A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

"},"Classes/MediaProxyService.html":{"name":"MediaProxyService","abstract":"

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

"},"Classes/ContentTypeCheckingImageDownloader.html":{"name":"ContentTypeCheckingImageDownloader"},"Classes/NetworkService.html":{"name":"NetworkService","abstract":"

Class responsible for sending all the networking requests, checking for http errors, RPC errors, Decoding the responses and optionally logging progress

"},"Classes/OperationService.html":{"name":"OperationService","abstract":"

Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

"},"Classes/TaquitoService.html":{"name":"TaquitoService","abstract":"

Taquito (https://github.com/ecadlabs/taquito) is a popular open source Tezos library written in Typescript and Javascript."},"Classes/TorusAuthService.html":{"name":"TorusAuthService","abstract":"

TorusAuthService is a wrapper around the SDK provided by: https://tor.us/ to allow the creation of TorusWallet‘s."},"Classes/WalletCacheService.html":{"name":"WalletCacheService","abstract":"

A service class used to store and retrieve Wallet objects such as RegularWallet, HDWallet, LedgerWallet and TorusWallet from the devices disk."},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Extensions.html":{"name":"Extensions","abstract":"

The following extensions are available globally.

"},"Protocols.html":{"name":"Protocols","abstract":"

The following protocols are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"},"Typealiases.html":{"name":"Type Aliases","abstract":"

The following type aliases are available globally.

"}} \ No newline at end of file diff --git a/docsets/.docset/Contents/Resources/docSet.dsidx b/docsets/.docset/Contents/Resources/docSet.dsidx new file mode 100644 index 00000000..4ef87fd1 Binary files /dev/null and b/docsets/.docset/Contents/Resources/docSet.dsidx differ diff --git a/docsets/.tgz b/docsets/.tgz new file mode 100644 index 00000000..c75ecffc Binary files /dev/null and b/docsets/.tgz differ diff --git a/docsets/.xml b/docsets/.xml new file mode 100644 index 00000000..96975ba4 --- /dev/null +++ b/docsets/.xml @@ -0,0 +1 @@ +1.0https://kukai-core-swift.kukai.app/docsets/.tgz diff --git a/img/carat.png b/img/carat.png new file mode 100755 index 00000000..29d2f7fd Binary files /dev/null and b/img/carat.png differ diff --git a/img/dash.png b/img/dash.png new file mode 100755 index 00000000..6f694c7a Binary files /dev/null and b/img/dash.png differ diff --git a/img/spinner.gif b/img/spinner.gif new file mode 100644 index 00000000..e3038d0a Binary files /dev/null and b/img/spinner.gif differ diff --git a/index.html b/index.html index ed60733f..f1df22e4 100644 --- a/index.html +++ b/index.html @@ -1,1909 +1,826 @@ - - - - KukaiCoreSwift - KukaiCoreSwift - - - + + Reference + + + + + + + + + + + +
- - - KukaiCoreSwift - - Documentation - -
- - - - - -
-
-
-

Classes

-
-
- - Better​Call​Dev​Client - -
-
-

BetterCallDev (BCD) is an indexer/smart contract debugging tool, used for the Tezos blockchain. -This class allows developers to interact with their API, to fetch data that would otherwise be impossible for a mobile app to fetch from the Tezos RPC

- -
-
- - Dip​Dup​Client - -
-
-

This client exposes functions to allow communication to the indexer platform DipDup ( https://dipdup.net/ ). -DipDup is composed of many small, dedicated indexers, powered by GraphQL. This client tries to exposes userflow functions, allowing users to accomplish tasks without having to worry about the underlying complexities

- -
-
- - Objkt​Client - -
-
-

Client for interacting with the API of the popular NFT marketplace, OBJKT.com -Client exposes functions for fetching metadata, pricing, purchase offers, listing etc

- -
-
- - Tezos​Domains​Client - -
-
-

A client class allowing integration with the tezos domains GraphQL API. See more here: https://tezos.domains/

- -
-
- - Tezos​Node​Client - -
-
-

The TezosNodeClient offers methods for interacting with the Tezos node to fetch balances, send transactions etc. -The client will abstract away all the compelx tasks of remote forging, parsing, signing, preapply and injecting operations. -It will also convert amounts from the network into Token objects to make common tasks easier.

- -
-
- - TzKTClient - -
-
-

TzKT is an indexer for Tezos, who's API allows developers to query details about wallets, transactions, bakers, account status etc

- -
-
- - Operation​Factory - -
-
-

Class responsible for creating operations necessary to perform a given action, and converting those operations into the single payload expected by the RPC. -Although not every action requires more than one operation, all functions will return an array, for consistency.

- -
-
- - Better​Call​Dev​Token​Metadata - -
-
-

A model matching the response that comes back from BetterCallDev's API: v1/tokens/<network>/metadata?contract=<address>

- -
-
- - HDWallet - -
-
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

- -
-
- - Ledger​Wallet - -
-
-

A Tezos wallet class, used to cache infomration regarding the paired ledger device used to sign the payload. -This class can only be created by fetching data from a Ledger device and supplying this data to the constructor.

- -
-
- - Operation - -
-
-

Base class representing an Operation on the Tezos network. On its own this class can't be sent to the network. See its subclasses for more info.

- -
-
- - Operation​Activate​Account - -
-
-

Operation subclass for revealing a publickey to the network.

- -
-
- - Operation​Ballot - -
-
-

Operation to submit a ballot on an upcoming proposal

- -
-
- - Operation​Delegation - -
-
-

Operation subclass for delegating an account to a baker

- -
-
- - Operation​Double​Baking​Evidence - -
-
-

Operation to report a baking of baking the same block twice

- -
-
- - Operation​Double​Endorsement​Evidence - -
-
-

Operation to report a baker trying to endorse a block twice

- -
-
- - Operation​Endorsement - -
-
-

Operation for endorsing a block

- -
-
- - Operation​Origination - -
-
-

Operation subclass for originating a contract on the Tezos network

- -
-
- - Operation​Proposals - -
-
- -
-
- - Operation​Reveal - -
-
-

Operation subclass for revealing a publickey to the network.

- -
-
- - Operation​Seed​Nonce​Revelation - -
-
-

Operation to reveal seed nonce to blockchain

- -
-
- - Operation​Transaction - -
-
-

Operation subclass for sending XTZ to a destination

- -
-
- - RPC - -
-
-

A generic class representing an RPC call to the Tezos network. -A type must be passed in when creating an instance of this object, this will be used by the network layer to parse the response and detect errors.

- -
-
- - Regular​Wallet - -
-
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

- -
-
- - Token - -
-
-

A class to represent a Token on the Tezos network. This class will do all the heavy lifting of converting values from the RPC to more human readbale values. -This class will also handle arithmetic functions, allowing developers to add and subtract tokens (useful when caluclating fees and total values).

- -
-
- - Token​Amount - -
-
-

Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length. -This class is used to encapsulate a BigInt and provide all the necessary init's and formatting functions to work with the networks requirements.

- -
-
- - Torus​Wallet - -
-
-

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address. -You should NOT store a copy of this class in a singleton or gloabl variable of any kind. it should be created as needed and nil'd when not. -In order to help developers achieve this, use the WalletCacheService to store/retreive an encrypted copy of the wallet on disk, and recreate the Wallet.

- -
-
- - XTZAmount - -
-
-

A subclass of TokenAmount to make it more explict when functions require XTZ (such as network fees). -It also serves as a means to more quickly create TokenAmount's conforming to XTZ.

- -
-
- - DApp​Helper​Service - -
-
-

A Helper service to simply combine multiple calls from other services, and/or map to specific responses, in order to expose a piece of functionality provided by a dApp

- -
-
- - Dex​Calculation​Service - -
-
-

Wrapper around the kukai-dex-calculations JS library for performing calculations: https://github.com/kukai-wallet/kukai-dex-calculations

- -
-
- - Disk​Service - -
-
-

A service class to write and read data from the devices documents directory

- -
-
- - Error​Handling​Service - -
-
-

A class used to process errors into more readable format, and optionally notifiy a global error handler of every error occuring

- -
-
- - Fee​Estimator​Service - -
-
-

An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker. -This avoids the need to ask users to enter a fee, which is not a very user friendly approach as most users wouldn't know what is required.

- -
-
- - Ledger​Service - -
-
-

A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

- -
-
- - Media​Proxy​Service - -
-
-

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

- -
-
- - Content​Type​Checking​Image​Downloader - -
-
- -
-
- - Network​Service - -
-
-

Class responsible for sending all the networking requests, checking for http errors, RPC errors, Decoding the responses and optionally logging progress

- -
-
- - Operation​Service - -
-
-

Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

- -
-
- - Taquito​Service - -
-
-

Taquito (https://github.com/ecadlabs/taquito) is a popular open source Tezos library written in Typescript and Javascript. -Taquito is made up of many separate packages that deal with various aspects of Tezos RPC and Michelson. -This serivce class is a wrapper around a small piece of the Taquito library to expose funtionality that would otherwise be time consuming/risky/dangerous to re-implement natively. -The JS can now be found on each github release here: https://github.com/ecadlabs/taquito/releases/, by extracting the zip named "taquito-local-forging-vanilla.zip"

- -
-
- - Torus​Auth​Service - -
-
-

TorusAuthService is a wrapper around the SDK provided by: https://tor.us/ to allow the creation of TorusWallet's. -This allows users to create a wallet from their social media accounts without having to use a seed phrase / mnemonic. -TorusAuthService allows Tezos apps to leverage this service for a number of providers, and also has the ability to query the network for someone else's wallet address, -based on their social profile. This allows you to send XTZ or tokens to your friend based on their twitter username for example

- -
-
- - Wallet​Cache​Service - -
-
-

A service class used to store and retrieve Wallet objects such as RegularWallet, HDWallet, LedgerWallet and TorusWallet from the devices disk. -This class will use the secure enclave (keychain if not available) to generate a key used to encrypt the contents locally, and retrieve. -This class will also store non senstiivve "metadata" about wallets, to allow storage of UI related data users might want to add, without cluttering up the wallet objects themselves

- -
-
-
-
-

Structures

-
-
- - Tezos​Domains​Client.​Both​Network​Reverse​Record - -
-
-

Object to wrap up a response fomr both networks

- -
-
- - TzKTClient.​Constants - -
-
-

Constants needed for interacting with the API

- -
-
- - Operation​Factory.​Extractor - -
-
-

Internal Struct to encapsulate helpers methods needed to extract critical information from an array of operations, needed for processing decisions like "do i display a send token screen, or a send NFt screen", fetching total XTZ sent in 1 action etc

- -
-
- - Account - -
-
-

Fetching all the account balances is a lengthy task, involving many requests and parsing different structures. -This struct abstract the developer away from knowing all these details, and instead allows developers to access wallets balances in a more normal approach

- -
-
- - Aggregate​Reward​Information - -
-
-

Object ot abstract away a significatn amount of logic involved in computing estimated reward payments from a baker

- -
-
- - Reward​Details - -
-
-

An individual payment record denoting some payment in the past or future

- -
-
- - Better​Call​Dev​Operation - -
-
-

A model matching the response that comes back from BetterCallDev's API: v1/opg/<operation-hash>

- -
-
- - Better​Call​Dev​Operation​Error - -
-
-

BetterCallDev structure for errors

- -
-
- - Dip​Dup​Chart​Data - -
-
-

Struct to hold 4 arrays of data, each one mapping to a different timeline of data, to allow the display of graphs

- -
-
- - Dip​Dup​Chart​Object - -
-
-

Structure holding a data slice

- -
-
- - Dip​Dup​Exchanges​And​Tokens​Response - -
-
-

Wrapper object to map to network response type

- -
-
- - Dip​Dup​Exchanges​And​Tokens - -
-
-

Wrapper object to map to network response type

- -
-
- - Dip​Dup​Exchange - -
-
-

A DipDup Exchange object with all the necessary pieces for checking liquidity and performing Swaps

- -
-
- - Dip​Dup​Position - -
-
-

Wrapper object to match network response type

- -
-
- - Dip​Dup​Position​Data - -
-
-

A position on DipDup corresponds to liquidity token ownership. Each of these objects represents an amount of Liquidity tokens in an exchange for the given address

- -
-
- - Dip​Dup​Token - -
-
-

DipDup representation of a Token

- -
-
- - TzKTAccount - -
-
-

Model mapping to TzKT.io's Account object

- -
-
- - TzKTAccount​Delegate - -
-
-

Model mapping to TzKT.io's Account.Delegate Object

- -
-
- - TzKTAddress - -
-
-

Details about a given contract

- -
-
- - TzKTBaker - -
-
-

Data representing a baker from TzKT or Baking-Bad

- -
-
- - TzKTBaker​Config - -
-
-

The bakers config file for details on when fees, min delegation etc change

- -
-
- - TzKTBaker​Config​Double​Value - -
-
- -
-
- - TzKTBaker​Config​Int​Value - -
-
- -
-
- - TzKTBaker​Config​Reward​Struct - -
-
-

Baker config payout flags

- -
-
- - TzKTBalance - -
-
-

Model mapping to the Balance object returned from the new TzKT API, resulting from the merge of BCD and TzKT

- -
-
- - TzKTBalance​Token - -
-
-

Model encapsulating information about the token itself

- -
-
- - TzKTBalance​Metadata - -
-
-

Metadata object for the token

- -
-
- - TzKTBalance​Metadata​Attribute​Key​Value - -
-
-

Wrapper / Helper to extract metadata attribute content

- -
-
- - TzKTBalance​Metadata​Format - -
-
-

Object containing information about the various formats the media is available in

- -
-
- - TzKTBalance​Metadata​Dimensions - -
-
-

Object containing information about the dimensions of a given piece of media

- -
-
- - TzKTCycle - -
-
-

The blockchain is broken down into cycles that last 2.7 days. Baker payment logic resolves around cycles instead of blocks

- -
-
- - TzKTDelegator​Reward - -
-
-

An object containing info on the reward a delegator should receive from a baker

- -
-
- - TzKTOperation - -
-
-

A model matching the response that comes back from TzKT's API: v1/operations/<operation-hash>

- -
-
- - TzKTOperation​Error - -
-
-

TzKT's more basic error object response

- -
-
- - TzKTToken​Transfer - -
-
-

FA1.2 / FA2 token transafers are treated differently from transactions. This object is used when fetching data form the API, as a temporary placeholder, ultimately to be merged into the transactions

- -
-
- - TzKTTransaction - -
-
-

A model matching the response that comes back from TzKT's API: v1/accounts/<address>/operations

- -
-
- - TzKTTransaction​Group - -
-
-

Artifical object used to group related transactions into a more user friendly display -For example, 1 contract call can reuslt in many transactions being returned. To avoid the users UI being clogged, we group all them into 1 group, so the user only needs to see 1 item for 1 action they performed

- -
-
- - Blockchain​Head - -
-
-

Structure representing the HEAD of the blockchain

- -
-
- - Logging​Config - -
-
-

A struct to control what messages get logged

- -
-
- - Tezos​Node​Client​Config - -
-
-

A configuration object used to provide settings to the TezosNodeClient

- -
-
- - Tezos​Node​Client​Config.​default​Mainnet​URLs - -
-
-

Preconfigured struct with all the URL's needed to work with Tezos mainnet

- -
-
- - Tezos​Node​Client​Config.​default​Testnet​URLs - -
-
-

Preconfigured struct with all the URL's needed to work with Tezos testnet

- -
-
- - Quipuswap​Exchange​Ledger​Key - -
-
-

The gneric container object holding the raw data

- -
-
- - Quipuswap​Exchange​Ledger - -
-
-

The unique data inside the Ledger BigMap

- -
-
- - Quipuswap​Exchange​Storage​Response - -
-
-

Network wrapper object

- -
-
- - Quipuswap​Exchange​Storage - -
-
-

Unique Quipuswap contract storage object

- -
-
- - Quipuswap​Exchange​User​Rewards​Key - -
-
-

The gneric container object holding the raw data

- -
-
- - Quipuswap​Exchange​User​Rewards - -
-
-

The unique data inside the User Rewards BigMap

- -
-
- - Fail​With​Parser​Liquidity​Baking - -
-
-

Dedicated "FailWith" parser for the codes received from Liquidity Baking contract

- -
-
- - Graph​QLError - -
-
-

GraphQL error object

- -
-
- - Graph​QLResponse - -
-
-

Simple model object to wrap a GraphQL response to expose a Codable response without having to use large GraphQL libraries

- -
-
- - Objkt​Collections - -
-
-

GarpQL bulk response for a group of collections

- -
-
- - Objkt​Collection - -
-
-

Single collection item

- -
-
- - Objkt​Creator - -
-
- -
-
- - Objkt​Token​Reponse - -
-
-

GarpQL response for required data for a given token

- -
-
- - Objkt​Token - -
-
-

Single token item

- -
-
- - Objkt​Attribute - -
-
- -
-
- - Objkt​Attribute​Data - -
-
- -
-
- - Objkt​Attribute​Counts - -
-
- -
-
- - Objkt​Sale - -
-
- -
-
- - Objkt​Listing - -
-
- -
-
- - Objkt​Event - -
-
-

Single event item

- -
-
- - Objkt​Fa - -
-
-

Single FA item

- -
-
- - Tezos​Domains​Address​Bulk​Response - -
-
-

Response object wrapper for querying an address in bulk

- -
-
- - Tezos​Domains​Domains - -
-
-

Object containing an array of domains

- -
-
- - Tezos​Domains​Address​Response - -
-
-

Response object wrapper for querying an address

- -
-
- - Tezos​Domains​Domain - -
-
-

Domain object containing details about the domain

- -
-
- - Tezos​Domains​Domain​Response - -
-
-

Response object wrapper for querying a reverse record

- -
-
- - Tezos​Domains​Domain​Bulk​Response - -
-
-

Response object wrapper for querying a reverse record in bulk

- -
-
- - Tezos​Domains​Reverse​Records - -
-
-

Object containing an array of reverse records

- -
-
- - Tezos​Domains​Reverse​Record - -
-
-

Object containing all the info of the tezos domains record

- -
-
- - Liquidity​Baking​Data - -
-
-

Wrapper object to hold onto all the necessary data in order to work with liquidity baking contract (swap, add or remove liqudity)

- -
-
- - NFT - -
-
-

An indiviual NFT (not the parent token/collection) holding a URI to an asset somewhere on the internet

- -
-
- - Network​Constants - -
-
-

The contants that a given Tezos node is using for block times, blakc size etc

- -
-
- - Network​Version - -
-
-

The version of the Tezos code being run by the given node

- -
-
- - Nil​OnDecoding​Error - -
-
-

property wrapper to easily handle a situation where we don't want decoding to fail for 1 property which may be problematic. Instead just default it to nil

- -
-
- - Operation​Block​Header - -
-
- -
-
- - Operation​Double​Endorsement​Evidence.​Inlined​Endorsement - -
-
-

Internal struct used to amtch expected struct of data

- -
-
- - Operation​Double​Endorsement​Evidence.​Inlined​Endorsement.​Content - -
-
- -
-
- - Operation​Fees - -
-
-

A structure representing all the fees, storage and computation needed to perform an Operation

- -
-
- - Operation​Metadata - -
-
-

Structure representing the metadata needed by Operation's in order to comply with the RPC standards

- -
-
- - Operation​Payload - -
-
-

A structure representing the request that needs to be made when sending Opertion's to the RPC

- -
-
- - Operation​Response - -
-
-

Structure representing the response returned from RPC endpoints such as .../preapply/operations

- -
-
- - Operation​Response​Content - -
-
-

The main content of the JSON returned

- -
-
- - Operation​Response​Metadata - -
-
-

The metadata belonging to the OperationResponse

- -
-
- - Balance​Update - -
-
-

Struct representing a change to the balance of the sender, destination or intermediary contract

- -
-
- - Operation​Response​Result - -
-
-

The inner result key from the OeprationResponse

- -
-
- - Operation​Response​Internal​Operation - -
-
-

Definition of the internal operation found inside OperationResponse

- -
-
- - Operation​Response​Internal​Result​Error - -
-
-

Definition of the outer Error object found inside OperationResponseInternalResult

- -
-
- - Fail​With - -
-
-

The error string, error int (code), or micheline error object returned inside FailWith

- -
-
- - Run​Operation​Payload - -
-
-

Payload object needed when sending operations to .../run_operation

- -
-
- - SVGImg​Processor - -
-
-

SVG image processor for Kingfisher library

- -
-
- - Operation​Subscription - -
-
-

Object for sending a request through SignalR to listen to operations for a given account

- -
-
- - DApp​Helper​Service.​Quipuswap - -
-
-

All functions related to Quipuswap

- -
-
- - Dex​Swap​Calculation​Result - -
-
-

A struct to hold all the necessary calculations for a dex trade

- -
-
- - Dex​Add​Calculation​Result - -
-
-

A struct to hold all the necessary calculations for adding liquidity to a dex contract

- -
-
- - Dex​Remove​Calculation​Result - -
-
-

A struct to hold all the necessary calculations for removing liquidity from a dex contract

- -
-
- - Kukai​Error - -
-
-

A struct conforming to Error, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves. -Comes with helpers to extract meaning from RPC errors, optionally includes all the network data that caused the error for easier retrieval, and a fallback human readbale description to ensure something useful is always shown to the user.

- -
-
- - Fee​Estimator​Service.​Fee​Constants - -
-
-

Constants needed to compute a fee

- -
-
- - Fee​Estimator​Service.​Estimation​Result - -
-
- -
-
- - DApp - -
-
- -
-
- - Offline​Constants - -
-
- -
-
- - Operation​Service.​Ledger​Payload​Prep​Response - -
-
-

Used to return a bunch of formatted data, to make interacting with ledger sign operation easier

- -
-
- - Subverifier​Wrapper - -
-
-

SDK requires information about the verifer that can't be stored inside the verifier, add a wrapper object to allow passing of all the data

- -
-
- - Wallet​Metadata​List - -
-
-

Container to store groups of WalletMetadata based on type

- -
-
- - Wallet​Metadata - -
-
-

Object to store UI related info about wallets, seperated from the wallet object itself to avoid issues merging together

- -
-
-
-
-

Enumerations

-
-
- - Better​Call​Dev​Client.​Better​Call​Dev​Client​Error - -
-
-

Dedicated BCD errors

- -
-
- - Tezos​Node​Client.​Tezos​Node​Client​Error - -
-
-

Types of errors

- -
-
- - TzKTClient.​TzKTService​Error - -
-
-

Unique Errors that TzKTClient can throw

- -
-
- - Result​Extension​Error - -
-
- -
-
- - Dip​Dup​Exchange​Name - -
-
-

Enum to wrap up the available types of Exchange on DipDup

- -
-
- - Dip​Dup​Token​Standard - -
-
-

Wrapping up the FA standards into an enum

- -
-
- - TzKTBaker​Health - -
-
-

The stability of the bakers server

- -
-
- - TzKTBaker​Accuracy - -
-
-

The accuracy of the bakers payments

- -
-
- - TzKTBaker​Timing - -
-
-

The reliability of the bakers payouts

- -
-
- - TzKTTransaction.​Transaction​Status - -
-
- -
-
- - TzKTTransaction.​Transaction​Type - -
-
- -
-
- - TzKTTransaction.​Transaction​Sub​Type - -
-
- -
-
- - TzKTTransaction.​Coding​Keys - -
-
- -
-
- - Tezos​Node​Client​Config.​Network​Type - -
-
-

An enum indicating whether the network is mainnet or testnet

- -
-
- - Tezos​Node​Client​Config.​Forging​Type - -
-
-

Allow switching between local forging or remote forging+parsing

- -
-
- - Biometric​Type - -
-
- -
-
- - Current​Device - -
-
-

Enum used to get details about the current device's capabilities

- -
-
- - HDWallet​Error - -
-
-

Error types that can be passed by failable inits

- -
-
- - Operation​Ballot.​Ballot - -
-
-

Enum matching the available ballot options

- -
-
- - Operation​Block​Header.​Coding​Keys - -
-
- -
-
- - Operation​Fees.​Network​Fee​Type - -
-
-

Enum to differentiate different types of extra fees. Such as allocation fees when sending to a currently unrevealed account.

- -
-
- - Operation​Kind - -
-
-

Enum representing the various kinds of supported Operation's

- -
-
- - Operation​Transaction​Error - -
-
- -
-
- - FaVersion - -
-
-

Enum representing the version of tezos "FA" token contracts

- -
-
- - Token.​Token​Type - -
-
-

An Enum to express the type of a token. Different processes are needed to fetch a balance for a users XTZ wallet, -versus fetching a FA1.2 token balance. This allows the library to abstract this logic away from the user and handle it all behind the scenes.

- -
-
- - Token​Amount.​Token​Amount​Error - -
-
- -
-
- - Wallet​Type - -
-
-

Enum to distingush between linear (non-hd) wallets, using the Bip39 standard, and hd wallets using the Bip44 standard.

- -
-
- - Wallet​Error - -
-
-

Possible error types that can occur when using the LedgerWallet

- -
-
- - Kukai​Error.​Error​Type - -
-
-

Categories of errors that are possible

- -
-
- - Fee​Estimator​Service.​Fee​Estimator​Service​Error - -
-
-

Various possible errors that can occur during an Estimation

- -
-
- - Ledger​Service.​General​Error​Codes - -
-
-

General Ledger error codes, pulled from the source, and some additional ones added for native swift issues

- -
-
- - Ledger​Service.​Tezos​App​Error​Codes - -
-
-

Dedicated error codes pulled from the Ledger tezos app

- -
-
- - Media​Proxy​Service​Error - -
-
- -
-
- - Cache​Type - -
-
- -
-
- - Media​Proxy​Service.​Format - -
-
-

Enum denoting the avaialble sizes for media

- -
-
- - Media​Proxy​Service.​Source - -
-
-

Supported source types for proxied media

- -
-
- - Media​Proxy​Service.​Media​Type - -
-
-

Supported media types

- -
-
- - Media​Proxy​Service.​Aggregated​Media​Type - -
-
-

Helper to parse a collection of media types to understand its contents

- -
-
- - Network​Service.​Network​Error - -
-
-

Errors that can be returned by the NetworkService

- -
-
- - DApp​Category - -
-
- -
-
- - DApp​Access​Type - -
-
- -
-
- - Operation​Service.​Operation​Service​Error - -
-
-

Errors that the OperationService is capable of returning

- -
-
- - Taquito​Service.​Taquito​Service​Error - -
-
-

Unique TaquitoService errors

- -
-
- - Torus​Auth​Provider - -
-
-

List of providers currently supported and available on the Tezos network

- -
-
- - Torus​Auth​Error - -
-
-

Custom TorusAuthService errors that cna be thrown

- -
-
-
-
-

Protocols

-
-
- - Fail​With​Parser - -
-
-

Protocol to allow defining multiple dedicated structs, one for each dApp, that knows how to convert the specific failWith cases into more human readable error messages

- -
-
- - Wallet - -
-
-

Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

- -
-
-
-
-

Typealiases

-
-
- - UIImage - -
-
-

Create "UIImage" as typealias of NSImage

- -
-
- - Quipuswap​Exchange​Ledger​Key​Response - -
-
-

Wrapper object around the network response

- -
-
- - Quipuswap​Exchange​User​Rewards​Key​Response - -
-
-

Wrapper object around the network response

- -
-
- - Nano​Tez - -
-
-

typealias to make it clearer when we are using NanoTez, which only is only used for fee calcualtion

- -
-
-
-
-

Extensions

-
-
- AnyPublisher -
-
-
- Array -
-
-
- Collection -
-
-
- Date -
-
-
- DateFormatter -
-
-
- Decimal -
-
-
- Dictionary -
-
-
- Error -
-
-
- KeyedDecodingContainer -
-
-
- Publisher -
-
-
- Result -
-
-
- String -
-
-
- Thread -
-
-
-
-
-
- -
-

- Generated on using swift-doc 1.0.0-rc.1. -

-
- +
+ +
+ +
+
+ +
+
+
+ +

Kukai Core Swift

+ +

Platforms +Swift Package Manager +License

+ +

Kukai Core Swift is a native Swift library for interacting with the Tezos blockchain and other applications in the Tezos ecosystem, such as the Tezos Node RPC, the indexer TzKT, the smart contract explorer Better Call Dev, the API from the NFT marketplace OBJKT.com etc.

+ +

The purpose of this SDK is not to provide a complete feature set for every aspect of Tezos, instead it is the base building block for the Kukai iOS mobile app, that we open source and make avaialble for anyone looking for similar functionality. We are open to accepting PR’s and discussing changes/features. However if its not related to the kuaki mobile app, such work is likely better suited in a standalone package, with this as a dependency.

+ +


+ +

Feature set includes:

+ +
    +
  • Create Regular and HD wallets
  • +
  • A service to cache and retrieve encrypted wallet details from disk, using the secure enclave
  • +
  • Fetching a wallet’s XTZ balance, all FA token balances, owned NFT’s grouped together by type, all in a single function call
  • +
  • Fetching transaction history, including token transfers
  • +
  • Remote forging using a second node or Local forging via @taquito/local-forging + +
      +
    • Using a “vanilla” javascript version of the local-forging package specifically. These JS files can be found under the taquito github releases, under assets, named taquito-local-forging-vanilla.zip. e.g. here
    • +
    • Created using this webpack config as a starting point
    • +
  • +
  • Estimating Gas, Storage and Fees for operations
  • +
  • Fetch Tezos domains from addresses, and addresses from domains
  • +
  • Media proxy tools for dealing with collectible and token images
  • +
  • Helpers for dealing with Michelson JSON
  • +
  • Helpers for parsing contents of Operations
  • +
  • Helpers for parsing errors
  • +
  • Dex fee + return calculation
  • +
+ +


+

+

Install

+ +

Kukai Core Swift supports the Swift Package Manager. Either use the Xcode editor to add to your project by clicking File -> Swift Packages -> Add Package Dependency, search for the git repo https://github.com/kukai-wallet/kukai-core-swift.git and choose from version x.x.x (see tags for latest).

+ +

Or add it to your Package.swift dependencies like so:

+
dependencies: [
+    .package(url: "https://github.com/kukai-wallet/kukai-core-swift", from: "x.x.x")
+]
+
+ +


+

+

How to use

+ +

Wallets are created using dedicated classes for each type, conforming to the Wallet protocol. Wallets are created using Mnemonic objects, see Kukai Crypto Swift for more details on those

+ +
    +
  • RegularWallet + +
      +
    • Created using a Mnemonic, an optional passphrase, and optionally specify the EllipticalCurve you want (ed25519 for TZ1…, secp256k1 for TZ2…)
    • +
  • +
  • HDWallet + +
      +
    • Created using a Mnemonic, an optional passphrase, and an optional BIP 44 derivation path
    • +
  • +
+ +


+ +

The main functionality centres around client classes and a factory:

+ +
    +
  • TezosNodeClient + +
      +
    • Query details about the node
    • +
    • Estimate fees via the node RPC
    • +
    • Send operations
    • +
  • +
  • TzKTClient + +
      +
    • Fetching balances
    • +
    • Transaction history
    • +
    • Determining if an operation has been successfully injected
    • +
  • +
  • OperationFactory + +
      +
    • Helper methods to create arrays of operations needed for common tasks
    • +
  • +
+ +


+ +

For working example, see the kukai mobile ios app here

+ +


+

+

Documentation

+ +

Compiled Swift Doc’s can be found here

+ +
+
+ +
+
+ diff --git a/js/jazzy.js b/js/jazzy.js new file mode 100755 index 00000000..19844166 --- /dev/null +++ b/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/js/jazzy.search.js b/js/jazzy.search.js new file mode 100644 index 00000000..359cdbb8 --- /dev/null +++ b/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
'; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
'; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/js/jquery.min.js b/js/jquery.min.js new file mode 100644 index 00000000..7f37b5d9 --- /dev/null +++ b/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.7.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(ie,e){"use strict";var oe=[],r=Object.getPrototypeOf,ae=oe.slice,g=oe.flat?function(e){return oe.flat.call(e)}:function(e){return oe.concat.apply([],e)},s=oe.push,se=oe.indexOf,n={},i=n.toString,ue=n.hasOwnProperty,o=ue.toString,a=o.call(Object),le={},v=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},y=function(e){return null!=e&&e===e.window},C=ie.document,u={type:!0,src:!0,nonce:!0,noModule:!0};function m(e,t,n){var r,i,o=(n=n||C).createElement("script");if(o.text=e,t)for(r in u)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function x(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[i.call(e)]||"object":typeof e}var t="3.7.1",l=/HTML$/i,ce=function(e,t){return new ce.fn.init(e,t)};function c(e){var t=!!e&&"length"in e&&e.length,n=x(e);return!v(e)&&!y(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+ge+")"+ge+"*"),x=new RegExp(ge+"|>"),j=new RegExp(g),A=new RegExp("^"+t+"$"),D={ID:new RegExp("^#("+t+")"),CLASS:new RegExp("^\\.("+t+")"),TAG:new RegExp("^("+t+"|[*])"),ATTR:new RegExp("^"+p),PSEUDO:new RegExp("^"+g),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+ge+"*(even|odd|(([+-]|)(\\d*)n|)"+ge+"*(?:([+-]|)"+ge+"*(\\d+)|))"+ge+"*\\)|)","i"),bool:new RegExp("^(?:"+f+")$","i"),needsContext:new RegExp("^"+ge+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+ge+"*((?:-\\d)?\\d*)"+ge+"*\\)|)(?=[^-]|$)","i")},N=/^(?:input|select|textarea|button)$/i,q=/^h\d$/i,L=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,H=/[+~]/,O=new RegExp("\\\\[\\da-fA-F]{1,6}"+ge+"?|\\\\([^\\r\\n\\f])","g"),P=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},M=function(){V()},R=J(function(e){return!0===e.disabled&&fe(e,"fieldset")},{dir:"parentNode",next:"legend"});try{k.apply(oe=ae.call(ye.childNodes),ye.childNodes),oe[ye.childNodes.length].nodeType}catch(e){k={apply:function(e,t){me.apply(e,ae.call(t))},call:function(e){me.apply(e,ae.call(arguments,1))}}}function I(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(V(e),e=e||T,C)){if(11!==p&&(u=L.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return k.call(n,a),n}else if(f&&(a=f.getElementById(i))&&I.contains(e,a)&&a.id===i)return k.call(n,a),n}else{if(u[2])return k.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&e.getElementsByClassName)return k.apply(n,e.getElementsByClassName(i)),n}if(!(h[t+" "]||d&&d.test(t))){if(c=t,f=e,1===p&&(x.test(t)||m.test(t))){(f=H.test(t)&&U(e.parentNode)||e)==e&&le.scope||((s=e.getAttribute("id"))?s=ce.escapeSelector(s):e.setAttribute("id",s=S)),o=(l=Y(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+Q(l[o]);c=l.join(",")}try{return k.apply(n,f.querySelectorAll(c)),n}catch(e){h(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return re(t.replace(ve,"$1"),e,n,r)}function W(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function F(e){return e[S]=!0,e}function $(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function B(t){return function(e){return fe(e,"input")&&e.type===t}}function _(t){return function(e){return(fe(e,"input")||fe(e,"button"))&&e.type===t}}function z(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&R(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function X(a){return F(function(o){return o=+o,F(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function U(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}function V(e){var t,n=e?e.ownerDocument||e:ye;return n!=T&&9===n.nodeType&&n.documentElement&&(r=(T=n).documentElement,C=!ce.isXMLDoc(T),i=r.matches||r.webkitMatchesSelector||r.msMatchesSelector,r.msMatchesSelector&&ye!=T&&(t=T.defaultView)&&t.top!==t&&t.addEventListener("unload",M),le.getById=$(function(e){return r.appendChild(e).id=ce.expando,!T.getElementsByName||!T.getElementsByName(ce.expando).length}),le.disconnectedMatch=$(function(e){return i.call(e,"*")}),le.scope=$(function(){return T.querySelectorAll(":scope")}),le.cssHas=$(function(){try{return T.querySelector(":has(*,:jqfake)"),!1}catch(e){return!0}}),le.getById?(b.filter.ID=function(e){var t=e.replace(O,P);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(O,P);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&C){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):t.querySelectorAll(e)},b.find.CLASS=function(e,t){if("undefined"!=typeof t.getElementsByClassName&&C)return t.getElementsByClassName(e)},d=[],$(function(e){var t;r.appendChild(e).innerHTML="",e.querySelectorAll("[selected]").length||d.push("\\["+ge+"*(?:value|"+f+")"),e.querySelectorAll("[id~="+S+"-]").length||d.push("~="),e.querySelectorAll("a#"+S+"+*").length||d.push(".#.+[+~]"),e.querySelectorAll(":checked").length||d.push(":checked"),(t=T.createElement("input")).setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),r.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&d.push(":enabled",":disabled"),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||d.push("\\["+ge+"*name"+ge+"*="+ge+"*(?:''|\"\")")}),le.cssHas||d.push(":has"),d=d.length&&new RegExp(d.join("|")),l=function(e,t){if(e===t)return a=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!le.sortDetached&&t.compareDocumentPosition(e)===n?e===T||e.ownerDocument==ye&&I.contains(ye,e)?-1:t===T||t.ownerDocument==ye&&I.contains(ye,t)?1:o?se.call(o,e)-se.call(o,t):0:4&n?-1:1)}),T}for(e in I.matches=function(e,t){return I(e,null,null,t)},I.matchesSelector=function(e,t){if(V(e),C&&!h[t+" "]&&(!d||!d.test(t)))try{var n=i.call(e,t);if(n||le.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){h(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(O,P),e[3]=(e[3]||e[4]||e[5]||"").replace(O,P),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||I.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&I.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return D.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&j.test(n)&&(t=Y(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(O,P).toLowerCase();return"*"===e?function(){return!0}:function(e){return fe(e,t)}},CLASS:function(e){var t=s[e+" "];return t||(t=new RegExp("(^|"+ge+")"+e+"("+ge+"|$)"))&&s(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=I.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function T(e,n,r){return v(n)?ce.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?ce.grep(e,function(e){return e===n!==r}):"string"!=typeof n?ce.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(ce.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||k,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:S.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof ce?t[0]:t,ce.merge(this,ce.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:C,!0)),w.test(r[1])&&ce.isPlainObject(t))for(r in t)v(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=C.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):v(e)?void 0!==n.ready?n.ready(e):e(ce):ce.makeArray(e,this)}).prototype=ce.fn,k=ce(C);var E=/^(?:parents|prev(?:Until|All))/,j={children:!0,contents:!0,next:!0,prev:!0};function A(e,t){while((e=e[t])&&1!==e.nodeType);return e}ce.fn.extend({has:function(e){var t=ce(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,Ce=/^$|^module$|\/(?:java|ecma)script/i;xe=C.createDocumentFragment().appendChild(C.createElement("div")),(be=C.createElement("input")).setAttribute("type","radio"),be.setAttribute("checked","checked"),be.setAttribute("name","t"),xe.appendChild(be),le.checkClone=xe.cloneNode(!0).cloneNode(!0).lastChild.checked,xe.innerHTML="",le.noCloneChecked=!!xe.cloneNode(!0).lastChild.defaultValue,xe.innerHTML="",le.option=!!xe.lastChild;var ke={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function Se(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&fe(e,t)?ce.merge([e],n):n}function Ee(e,t){for(var n=0,r=e.length;n",""]);var je=/<|&#?\w+;/;function Ae(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function Re(e,t){return fe(e,"table")&&fe(11!==t.nodeType?t:t.firstChild,"tr")&&ce(e).children("tbody")[0]||e}function Ie(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function We(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Fe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(_.hasData(e)&&(s=_.get(e).events))for(i in _.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),C.head.appendChild(r[0])},abort:function(){i&&i()}}});var Jt,Kt=[],Zt=/(=)\?(?=&|$)|\?\?/;ce.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Kt.pop()||ce.expando+"_"+jt.guid++;return this[e]=!0,e}}),ce.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Zt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Zt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=v(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Zt,"$1"+r):!1!==e.jsonp&&(e.url+=(At.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||ce.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=ie[r],ie[r]=function(){o=arguments},n.always(function(){void 0===i?ce(ie).removeProp(r):ie[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Kt.push(r)),o&&v(i)&&i(o[0]),o=i=void 0}),"script"}),le.createHTMLDocument=((Jt=C.implementation.createHTMLDocument("").body).innerHTML="
",2===Jt.childNodes.length),ce.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(le.createHTMLDocument?((r=(t=C.implementation.createHTMLDocument("")).createElement("base")).href=C.location.href,t.head.appendChild(r)):t=C),o=!n&&[],(i=w.exec(e))?[t.createElement(i[1])]:(i=Ae([e],t,o),o&&o.length&&ce(o).remove(),ce.merge([],i.childNodes)));var r,i,o},ce.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(ce.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},ce.expr.pseudos.animated=function(t){return ce.grep(ce.timers,function(e){return t===e.elem}).length},ce.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=ce.css(e,"position"),c=ce(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=ce.css(e,"top"),u=ce.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),v(t)&&(t=t.call(e,n,ce.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},ce.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){ce.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===ce.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===ce.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=ce(e).offset()).top+=ce.css(e,"borderTopWidth",!0),i.left+=ce.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-ce.css(r,"marginTop",!0),left:t.left-i.left-ce.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===ce.css(e,"position"))e=e.offsetParent;return e||J})}}),ce.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;ce.fn[t]=function(e){return M(this,function(e,t,n){var r;if(y(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),ce.each(["top","left"],function(e,n){ce.cssHooks[n]=Ye(le.pixelPosition,function(e,t){if(t)return t=Ge(e,n),_e.test(t)?ce(e).position()[n]+"px":t})}),ce.each({Height:"height",Width:"width"},function(a,s){ce.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){ce.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return M(this,function(e,t,n){var r;return y(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?ce.css(e,t,i):ce.style(e,t,n,i)},s,n?e:void 0,n)}})}),ce.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){ce.fn[t]=function(e){return this.on(t,e)}}),ce.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.on("mouseenter",e).on("mouseleave",t||e)}}),ce.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){ce.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/js/typeahead.jquery.js b/js/typeahead.jquery.js new file mode 100644 index 00000000..3a2d2ab0 --- /dev/null +++ b/js/typeahead.jquery.js @@ -0,0 +1,1694 @@ +/*! + * typeahead.js 1.3.1 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Aa]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Bb]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Cc]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Dd]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ee]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflFf]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Gg]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Hh]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiIi]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼJj]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Kk]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflLl]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Mm]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Nn]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Oo]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Pp]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Qq]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Rr]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stSs]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstTt]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Uu]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Vv]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ww]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Xx]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Yy]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Zz]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
"); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
"); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
"); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
"); + $menu = this.menu.$node || $("
"); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/search.json b/search.json new file mode 100644 index 00000000..4f6e3502 --- /dev/null +++ b/search.json @@ -0,0 +1 @@ +{"Typealiases.html#/UIImage":{"name":"UIImage","abstract":"

Create “UIImage” as typealias of NSImage

"},"Typealiases.html#/s:14KukaiCoreSwift34QuipuswapExchangeLedgerKeyResponsea":{"name":"QuipuswapExchangeLedgerKeyResponse","abstract":"

Wrapper object around the network response

"},"Typealiases.html#/s:14KukaiCoreSwift39QuipuswapExchangeUserRewardsKeyResponsea":{"name":"QuipuswapExchangeUserRewardsKeyResponse","abstract":"

Wrapper object around the network response

"},"Typealiases.html#/s:14KukaiCoreSwift7NanoTeza":{"name":"NanoTez","abstract":"

typealias to make it clearer when we are using NanoTez, which only is only used for fee calcualtion

"},"Structs/SubverifierWrapper.html#/s:14KukaiCoreSwift18SubverifierWrapperV21aggregateVerifierNameSSSgvp":{"name":"aggregateVerifierName","abstract":"

The name of the aggregated verifier

","parent_name":"SubverifierWrapper"},"Structs/SubverifierWrapper.html#/s:14KukaiCoreSwift18SubverifierWrapperV11networkTypeAA21TezosNodeClientConfigV07NetworkG0Ovp":{"name":"networkType","abstract":"

Unlike seed based wallets, Torus verifiers are bound to a network and generate different addresses. In order to give the same experience on Tezos, we need to supply the network for each verifier

","parent_name":"SubverifierWrapper"},"Structs/SubverifierWrapper.html#/s:14KukaiCoreSwift18SubverifierWrapperV11subverifier10CustomAuth18SubVerifierDetailsVvp":{"name":"subverifier","abstract":"

The matching SubVerifierDetails object

","parent_name":"SubverifierWrapper"},"Structs/SubverifierWrapper.html#/s:14KukaiCoreSwift18SubverifierWrapperV21aggregateVerifierName11networkType11subverifierACSSSg_AA21TezosNodeClientConfigV07NetworkJ0O10CustomAuth03SubG7DetailsVtcfc":{"name":"init(aggregateVerifierName:networkType:subverifier:)","abstract":"

Create an instance of the object with an option string for the aggregate verifier name, and a SubVerifierDetails object

","parent_name":"SubverifierWrapper"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO3rpcyA2EmF":{"name":"rpc","abstract":"

RPC errors come directly from the Tezos RPC, but with the massive JSON object filtered down to the most meraningful part

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO6systemyA2EmF":{"name":"system","abstract":"

System errors are ones coming from the OS, e.g. “No internet connection”

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO7networkyAESicAEmF":{"name":"network(_:)","abstract":"

Network errors are returned by a server, such as HTTP 404’s and 500’s

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO19internalApplicationyA2EmF":{"name":"internalApplication","abstract":"

Internal application errors are errors from other services, components, libraiers etc, wrapped up so that they don’t require extra parsing

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO08decodingD0yA2EmF":{"name":"decodingError","abstract":"

For situations where the wrong model is returned. This can happen sometimes unexpectedily in GraphQL based APIs, instead of returning an error, it will just return a partial object missing non-optional fields

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO05knownD0yA2EmF":{"name":"knownError","abstract":"

For clients to catch known errors, sometimes handled in odd ways, enabling the easy return of a String. E.g. GraphQL throwing a malformed object response for a situation that should be a 404

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html#/s:14KukaiCoreSwift0A5ErrorV0D4TypeO7unknownyA2EmF":{"name":"unknown","abstract":"

Used as a fallback for strange edge cases where we can’t easily idenitfiy the issue

","parent_name":"ErrorType"},"Structs/KukaiError/ErrorType.html":{"name":"ErrorType","abstract":"

Categories of errors that are possible

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV9errorTypeAC0dF0Ovp":{"name":"errorType","abstract":"

The error category

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV05knownD7MessageSSSgvp":{"name":"knownErrorMessage","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV7subTypes0D0_pSgvp":{"name":"subType","abstract":"

Optional error subType coming from another source (the OS, URLSession, another library etc)

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV03rpcD6StringSSSgvp":{"name":"rpcErrorString","abstract":"

Optional string containing only the relvant portion of an RPC error (e.g instead of “proto.xxxxxxxx.gas_exhausted.operation”, it would contain “gas_exhausted.operation”) to make parsing easier

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV8failWithAA04FailF0VSgvp":{"name":"failWith","abstract":"

Optional object containing smart contract failure casues. May contain an Int (error code), a String (semi human readbale error message), and/or a dictionary containing metadata

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV10requestURL10Foundation0F0VSgvp":{"name":"requestURL","abstract":"

The requested URL that returned the error

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV11requestJSONSSSgvp":{"name":"requestJSON","abstract":"

The JSON that was sent as part of the request

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV12responseJSONSSSgvp":{"name":"responseJSON","abstract":"

The raw JSON that was returned

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV14httpStatusCodeSiSgvp":{"name":"httpStatusCode","abstract":"

The HTTP status code returned

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV03rpcD00eD6String11andFailWithACSS_AA0hI0VSgtFZ":{"name":"rpcError(rpcErrorString:andFailWith:)","abstract":"

Create a KukaiError from an RPC string (will not be validated). You can use the string extension .removeLeadingProtocolFromRPCError() to strip the leading poriton of the error

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV06systemD07subTypeACs0D0_p_tFZ":{"name":"systemError(subType:)","abstract":"

Create a KukaiError denoting a sytem issue from the OS, by passing in the system Error type

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV07networkD010statusCode10requestURLACSi_10Foundation0I0VtFZ":{"name":"networkError(statusCode:requestURL:)","abstract":"

Create a KukaiError denoting a network issue, by passing in the HTTP status code

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV019internalApplicationD05errorACs0D0_p_tFZ":{"name":"internalApplicationError(error:)","abstract":"

Create a KukaiError denoting an issue from some other component or library, by passing in the error that piece of code returned

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV08decodingD05errorACs0D0_p_tFZ":{"name":"decodingError(error:)","abstract":"

Create a KukaiError denoting an issue from some other component or library, by passing in the error that piece of code returned

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV05knownD7MessageyACSSFZ":{"name":"knownErrorMessage(_:)","abstract":"

Create a KukaiError allowing a client to simply provide the required error message.","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV7unknown10withStringACSSSg_tFZ":{"name":"unknown(withString:)","abstract":"

Create an unknown KukaiError

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV14addNetworkData10requestURL0H4JSON08responseJ014httpStatusCodey10Foundation0I0VSg_AI0G0VSgAOSiSgtF":{"name":"addNetworkData(requestURL:requestJSON:responseJSON:httpStatusCode:)","abstract":"

For network errors, attach all the necessary network data that may be needed in order to debug the issue, or log to a tool such as sentry

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV11descriptionSSvp":{"name":"description","abstract":"

Prints the underlying error type with either an RPC string, or an underlying Error object contents

","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV05checkD12ForKnownCaseySSSgs0D0_pF":{"name":"checkErrorForKnownCase(_:)","parent_name":"KukaiError"},"Structs/KukaiError.html#/s:14KukaiCoreSwift0A5ErrorV27messageForNetworkStatusCode06statusI03urlSSSi_10Foundation3URLVtF":{"name":"messageForNetworkStatusCode(statusCode:url:)","parent_name":"KukaiError"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV11expectedXTZAA9XTZAmountCvp":{"name":"expectedXTZ","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV10minimumXTZAA9XTZAmountCvp":{"name":"minimumXTZ","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV13expectedTokenAA0I6AmountCvp":{"name":"expectedToken","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV12minimumTokenAA0I6AmountCvp":{"name":"minimumToken","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV12exchangeRateSo9NSDecimalavp":{"name":"exchangeRate","parent_name":"DexRemoveCalculationResult"},"Structs/DexRemoveCalculationResult.html#/s:14KukaiCoreSwift26DexRemoveCalculationResultV11expectedXTZ07minimumI00H5Token0jK012exchangeRateAcA9XTZAmountC_AjA0K6AmountCALSo9NSDecimalatcfc":{"name":"init(expectedXTZ:minimumXTZ:expectedToken:minimumToken:exchangeRate:)","parent_name":"DexRemoveCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV17expectedLiquidityAA11TokenAmountCvp":{"name":"expectedLiquidity","parent_name":"DexAddCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV16minimumLiquidityAA11TokenAmountCvp":{"name":"minimumLiquidity","parent_name":"DexAddCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV13tokenRequiredAA11TokenAmountCvp":{"name":"tokenRequired","parent_name":"DexAddCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV12exchangeRateSo9NSDecimalavp":{"name":"exchangeRate","parent_name":"DexAddCalculationResult"},"Structs/DexAddCalculationResult.html#/s:14KukaiCoreSwift23DexAddCalculationResultV17expectedLiquidity07minimumI013tokenRequired12exchangeRateAcA11TokenAmountC_A2ISo9NSDecimalatcfc":{"name":"init(expectedLiquidity:minimumLiquidity:tokenRequired:exchangeRate:)","parent_name":"DexAddCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV8expectedAA11TokenAmountCvp":{"name":"expected","parent_name":"DexSwapCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV7minimumAA11TokenAmountCvp":{"name":"minimum","parent_name":"DexSwapCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV19displayExchangeRateSo9NSDecimalavp":{"name":"displayExchangeRate","parent_name":"DexSwapCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV18displayPriceImpactSdvp":{"name":"displayPriceImpact","parent_name":"DexSwapCalculationResult"},"Structs/DexSwapCalculationResult.html#/s:14KukaiCoreSwift24DexSwapCalculationResultV8expected7minimum19displayExchangeRate0J11PriceImpactAcA11TokenAmountC_AISo9NSDecimalaSdtcfc":{"name":"init(expected:minimum:displayExchangeRate:displayPriceImpact:)","parent_name":"DexSwapCalculationResult"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV7addressSSvp":{"name":"address","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV02hdD9GroupNameSSSgvp":{"name":"hdWalletGroupName","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV14walletNicknameSSSgvp":{"name":"walletNickname","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV14socialUsernameSSSgvp":{"name":"socialUsername","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV14mainnetDomainsSayAA05TezosG13ReverseRecordVGSgvp":{"name":"mainnetDomains","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV15ghostnetDomainsSayAA05TezosG13ReverseRecordVGSgvp":{"name":"ghostnetDomains","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV10socialTypeAA17TorusAuthProviderOSgvp":{"name":"socialType","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV4typeAA0D4TypeOvp":{"name":"type","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV8childrenSayACGvp":{"name":"children","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV7isChildSbvp":{"name":"isChild","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV11isWatchOnlySbvp":{"name":"isWatchOnly","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV21bas58EncodedPublicKeySSvp":{"name":"bas58EncodedPublicKey","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV8backedUpSbvp":{"name":"backedUp","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV16hasMainnetDomainSbyF":{"name":"hasMainnetDomain()","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV17hasGhostnetDomainSbyF":{"name":"hasGhostnetDomain()","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV9hasDomain9onNetworkSbAA21TezosNodeClientConfigV0I4TypeO_tF":{"name":"hasDomain(onNetwork:)","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV20primaryMainnetDomainAA25TezosDomainsReverseRecordVSgyF":{"name":"primaryMainnetDomain()","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV21primaryGhostnetDomainAA25TezosDomainsReverseRecordVSgyF":{"name":"primaryGhostnetDomain()","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV13primaryDomain9onNetworkAA25TezosDomainsReverseRecordVSgAA0J16NodeClientConfigV0I4TypeO_tF":{"name":"primaryDomain(onNetwork:)","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:14KukaiCoreSwift14WalletMetadataV7address02hdD9GroupName14walletNickname14socialUsername14mainnetDomains08ghostnetO00L4Type4type8children7isChild0T9WatchOnly21bas58EncodedPublicKey8backedUpACSS_SSSgA2QSayAA05TezosO13ReverseRecordVGSgAuA17TorusAuthProviderOSgAA0dQ0OSayACGS2bSSSbtcfc":{"name":"init(address:hdWalletGroupName:walletNickname:socialUsername:mainnetDomains:ghostnetDomains:socialType:type:children:isChild:isWatchOnly:bas58EncodedPublicKey:backedUp:)","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"WalletMetadata"},"Structs/WalletMetadata.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"WalletMetadata"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV13socialWalletsSayAA0dE0VGvp":{"name":"socialWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV9hdWalletsSayAA0dE0VGvp":{"name":"hdWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV13linearWalletsSayAA0dE0VGvp":{"name":"linearWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV13ledgerWalletsSayAA0dE0VGvp":{"name":"ledgerWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV12watchWalletsSayAA0dE0VGvp":{"name":"watchWallets","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV13socialWallets02hdH006linearH006ledgerH005watchH0ACSayAA0dE0VG_A4Ktcfc":{"name":"init(socialWallets:hdWallets:linearWallets:ledgerWallets:watchWallets:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV7isEmptySbyF":{"name":"isEmpty()","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV05firstE0AA0dE0VSgyF":{"name":"firstMetadata()","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV8metadata10forAddressAA0dE0VSgSS_tF":{"name":"metadata(forAddress:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV6update7address4withSbSS_AA0dE0VtF":{"name":"update(address:with:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV3set13mainnetDomain08ghostnetI010forAddressSbAA25TezosDomainsReverseRecordVSg_AJSStF":{"name":"set(mainnetDomain:ghostnetDomain:forAddress:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV3set8nickname10forAddressSbSSSg_SStF":{"name":"set(nickname:forAddress:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV3set02hdD9GroupName10forAddressSbSS_SStF":{"name":"set(hdWalletGroupName:forAddress:)","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV5countSiyF":{"name":"count()","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV9addressesSaySSGyF":{"name":"addresses()","parent_name":"WalletMetadataList"},"Structs/WalletMetadataList.html#/s:14KukaiCoreSwift18WalletMetadataListV03allE013onlySeedBasedSayAA0dE0VGSb_tF":{"name":"allMetadata(onlySeedBased:)","parent_name":"WalletMetadataList"},"Structs/SVGImgProcessor.html#/s:10Kingfisher14ImageProcessorP10identifierSSvp":{"name":"identifier","parent_name":"SVGImgProcessor"},"Structs/SVGImgProcessor.html#/s:10Kingfisher14ImageProcessorP7process4item7optionsSo7UIImageCSgAA0B11ProcessItemO_AA0A17ParsedOptionsInfoVtF":{"name":"process(item:options:)","parent_name":"SVGImgProcessor"},"Structs/FailWith.html#/s:14KukaiCoreSwift8FailWithV6stringSSSgvp":{"name":"string","parent_name":"FailWith"},"Structs/FailWith.html#/s:14KukaiCoreSwift8FailWithV3intSSSgvp":{"name":"int","parent_name":"FailWith"},"Structs/FailWith.html#/s:14KukaiCoreSwift8FailWithV4argsSaySDyS2SGGSgvp":{"name":"args","parent_name":"FailWith"},"Structs/FailWith.html#/s:14KukaiCoreSwift8FailWithV6string3int4argsACSSSg_AGSaySDyS2SGGSgtcfc":{"name":"init(string:int:args:)","parent_name":"FailWith"},"Structs/FailWith.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"FailWith"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV4kindSSvp":{"name":"kind","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV2idSSvp":{"name":"id","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV8contractSSSgvp":{"name":"contract","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV8expectedSSSgvp":{"name":"expected","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV5foundSSSgvp":{"name":"found","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV8locationSiSgvp":{"name":"location","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponseInternalResultError.html#/s:14KukaiCoreSwift36OperationResponseInternalResultErrorV4withAA8FailWithVSgvp":{"name":"with","parent_name":"OperationResponseInternalResultError"},"Structs/OperationResponse.html#/s:14KukaiCoreSwift17OperationResponseV8contentsSayAA0dE7ContentVGvp":{"name":"contents","parent_name":"OperationResponse"},"Structs/OperationResponse.html#/s:14KukaiCoreSwift17OperationResponseV8isFailedSbyF":{"name":"isFailed()","abstract":"

Check if the operation(s) have been backtracked or reversed due to a failure

","parent_name":"OperationResponse"},"Structs/OperationResponse.html#/s:14KukaiCoreSwift17OperationResponseV6errorsSayAA0dE19InternalResultErrorVGyF":{"name":"errors()","abstract":"

Return the last error object from each internal result. The last error object is the one that contains the location of the error in the smart contract and the with string, giving the most debugable information

","parent_name":"OperationResponse"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV6branchSSvp":{"name":"branch","abstract":"

The bracnh to use when sending

","parent_name":"OperationPayload"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV8contentsSayAA0D0CGvp":{"name":"contents","abstract":"

An array of Operation‘s to be sent together in 1 request.

","parent_name":"OperationPayload"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable

","parent_name":"OperationPayload"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV12addSignature_12signingCurveySays5UInt8VG_0a6CryptoC0010EllipticalI0OtF":{"name":"addSignature(_:signingCurve:)","abstract":"

Add the signature and the protocol to the operation so that it can be injected to the blockchain

","parent_name":"OperationPayload"},"Structs/OperationPayload.html#/s:14KukaiCoreSwift16OperationPayloadV10addProtcol12fromMetadatayAA0dI0V_tF":{"name":"addProtcol(fromMetadata:)","parent_name":"OperationPayload"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV10managerKeySSSgvp":{"name":"managerKey","abstract":"

The public key of the account managing the sender of this Operation

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV7counterSivp":{"name":"counter","abstract":"

The current counter used by this account on the network. All future Operation‘s need to be 1 higher

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV7chainIDSSvp":{"name":"chainID","abstract":"

The current Tezos network chainID to use for Operation‘s

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV6branchSSvp":{"name":"branch","abstract":"

The current branch used by the head block, used for estiamting and running preapply, to ensure the latest state information is available

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV8protocolSSvp":{"name":"protocol","abstract":"

The current Tezos network protocol to use for Operation‘s

","parent_name":"OperationMetadata"},"Structs/OperationMetadata.html#/s:14KukaiCoreSwift17OperationMetadataV10managerKey7counter14blockchainHeadACSSSg_SiAA010BlockchainJ0Vtcfc":{"name":"init(managerKey:counter:blockchainHead:)","abstract":"

Create an OperationMetadata

","parent_name":"OperationMetadata"},"Structs/OperationFees/NetworkFeeType.html#/s:14KukaiCoreSwift13OperationFeesV14NetworkFeeTypeO04burnG0yA2EmF":{"name":"burnFee","parent_name":"NetworkFeeType"},"Structs/OperationFees/NetworkFeeType.html#/s:14KukaiCoreSwift13OperationFeesV14NetworkFeeTypeO010allocationG0yA2EmF":{"name":"allocationFee","parent_name":"NetworkFeeType"},"Structs/OperationFees/NetworkFeeType.html":{"name":"NetworkFeeType","abstract":"

Enum to differentiate different types of extra fees. Such as allocation fees when sending to a currently unrevealed account.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV14transactionFeeAA9XTZAmountCvp":{"name":"transactionFee","abstract":"

The transaction fee that the sender is willing to pay in order to perform the Operation.","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV07networkE0SDyAC14NetworkFeeTypeOAA9XTZAmountCGvp":{"name":"networkFees","abstract":"

Additional fees the account will have to pay in order to send this operation. Such as allocating space for an unrevealed account.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV8gasLimitSivp":{"name":"gasLimit","abstract":"

The limit of gas (computation + CPU) this Operation should take. If it exceeds this value when running, the Operation will fail.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV12storageLimitSivp":{"name":"storageLimit","abstract":"

The limit of storage (disk) this Operation requires to complete. If it exceeds this value when running, the Operation will fail.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV03allE0AA9XTZAmountCyF":{"name":"allFees()","abstract":"

Add together all the network fees and transaction fees

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV010allNetworkE0AA9XTZAmountCyF":{"name":"allNetworkFees()","abstract":"

Add together all the network fees and transaction fees

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV4zeroACyFZ":{"name":"zero()","abstract":"

Creates an OperationFees object, with everything set to zero. Primarly used as a default / placeholder until an estimation can be performed

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV07defaultE013operationKindAcA0dH0O_tFZ":{"name":"defaultFees(operationKind:)","abstract":"

Get a default fees for each type of Operation. No guarentee these will succeed.

","parent_name":"OperationFees"},"Structs/OperationFees.html#/s:14KukaiCoreSwift13OperationFeesV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Confirming to Equatable

","parent_name":"OperationFees"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO5levelyA2EmF":{"name":"level","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO5protoyA2EmF":{"name":"proto","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO11predecessoryA2EmF":{"name":"predecessor","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO9timestampyA2EmF":{"name":"timestamp","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO14validationPassyA2EmF":{"name":"validationPass","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO14operationsHashyA2EmF":{"name":"operationsHash","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO7fitnessyA2EmF":{"name":"fitness","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO7contextyA2EmF":{"name":"context","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO8priorityyA2EmF":{"name":"priority","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO16proofOfWorkNonceyA2EmF":{"name":"proofOfWorkNonce","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO13seedNonceHashyA2EmF":{"name":"seedNonceHash","parent_name":"CodingKeys"},"Structs/OperationBlockHeader/CodingKeys.html#/s:14KukaiCoreSwift20OperationBlockHeaderV10CodingKeysO9signatureyA2EmF":{"name":"signature","parent_name":"CodingKeys"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV5levelSivp":{"name":"level","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV5protoSivp":{"name":"proto","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV11predecessorSSvp":{"name":"predecessor","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV9timestamp10Foundation4DateVvp":{"name":"timestamp","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV14validationPassSivp":{"name":"validationPass","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV14operationsHashSSvp":{"name":"operationsHash","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV7fitnessSaySSGvp":{"name":"fitness","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV7contextSSvp":{"name":"context","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV8prioritySivp":{"name":"priority","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV16proofOfWorkNonceSSvp":{"name":"proofOfWorkNonce","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV13seedNonceHashSSSgvp":{"name":"seedNonceHash","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV9signatureSSvp":{"name":"signature","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:14KukaiCoreSwift20OperationBlockHeaderV5level5proto11predecessor9timestamp14validationPass14operationsHash7fitness7context8priority16proofOfWorkNonce04seeduN09signatureACSi_SiSS10Foundation4DateVSiSSSaySSGSSSiS2SSgSStcfc":{"name":"init(level:proto:predecessor:timestamp:validationPass:operationsHash:fitness:context:priority:proofOfWorkNonce:seedNonceHash:signature:)","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationBlockHeader"},"Structs/OperationBlockHeader/CodingKeys.html":{"name":"CodingKeys","parent_name":"OperationBlockHeader"},"Structs/NilOnDecodingError.html#/s:14KukaiCoreSwift18NilOnDecodingErrorV12wrappedValueACyxGxSg_tcfc":{"name":"init(wrappedValue:)","parent_name":"NilOnDecodingError"},"Structs/NilOnDecodingError.html#/s:14KukaiCoreSwift18NilOnDecodingErrorV12wrappedValuexSgvp":{"name":"wrappedValue","parent_name":"NilOnDecodingError"},"Structs/NilOnDecodingError.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"NilOnDecodingError"},"Structs/NilOnDecodingError.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"NilOnDecodingError"},"Structs/NetworkVersion.html#/s:14KukaiCoreSwift14NetworkVersionV17chainName_mainnetSSvpZ":{"name":"chainName_mainnet","parent_name":"NetworkVersion"},"Structs/NetworkVersion.html#/s:14KukaiCoreSwift14NetworkVersionV9chainNameSSyF":{"name":"chainName()","parent_name":"NetworkVersion"},"Structs/NetworkVersion.html#/s:14KukaiCoreSwift14NetworkVersionV9isMainnetSbyF":{"name":"isMainnet()","parent_name":"NetworkVersion"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV19minimal_block_delaySSvp":{"name":"minimal_block_delay","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV28hard_gas_limit_per_operationSSvp":{"name":"hard_gas_limit_per_operation","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV24hard_gas_limit_per_blockSSvp":{"name":"hard_gas_limit_per_block","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV16origination_sizeSivp":{"name":"origination_size","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV13cost_per_byteSSvp":{"name":"cost_per_byte","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV32hard_storage_limit_per_operationSSvp":{"name":"hard_storage_limit_per_operation","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV20secondsBetweenBlocksSiyF":{"name":"secondsBetweenBlocks()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV12mutezPerByteSiyF":{"name":"mutezPerByte()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV10xtzPerByteAA9XTZAmountCyF":{"name":"xtzPerByte()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV18maxGasPerOperationSiyF":{"name":"maxGasPerOperation()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV14maxGasPerBlockSiyF":{"name":"maxGasPerBlock()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV22maxStoragePerOperationSiyF":{"name":"maxStoragePerOperation()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV14bytesForRevealSiyF":{"name":"bytesForReveal()","parent_name":"NetworkConstants"},"Structs/NetworkConstants.html#/s:14KukaiCoreSwift16NetworkConstantsV12xtzForRevealAA9XTZAmountCyF":{"name":"xtzForReveal()","parent_name":"NetworkConstants"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV7tokenIdSo9NSDecimalavp":{"name":"tokenId","abstract":"

Each NFT of a token has a unique ID

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11duplicateIDSiSgvp":{"name":"duplicateID","abstract":"

In order to display in a tablview, the element must be hashable. But in cases where you want to show duplciates (e.g. recents), the computed hash needs to be slightly different","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV14parentContractSSvp":{"name":"parentContract","abstract":"

The address of the FA2 contract that created this NFT

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11parentAliasSSSgvp":{"name":"parentAlias","abstract":"

The human readable alias of the parent contract (e.g. “Mooncakes”)

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV9faVersionAA02FaF0Ovp":{"name":"faVersion","abstract":"

The FaVersion of the token contrac

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"

Get the underlying number of decimal places that this token represents

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV7balanceSo9NSDecimalavp":{"name":"balance","abstract":"

Number of duplicate items of this NFT

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV4nameSSvp":{"name":"name","abstract":"

Human readbale name (e.g. “Tezos”)

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV6symbolSSSgvp":{"name":"symbol","abstract":"

Human readbale symbol (e.g. “XTZ”)

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11descriptionSSvp":{"name":"description","abstract":"

Human readable description (e.g. “This NFT was created too…”)

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11artifactURI10Foundation3URLVSgvp":{"name":"artifactURI","abstract":"

A URI to the asset the NFT is controlling ownership of

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV10displayURI10Foundation3URLVSgvp":{"name":"displayURI","abstract":"

A URI used to display media of the artifact

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV12thumbnailURI10Foundation3URLVSgvp":{"name":"thumbnailURI","abstract":"

A smaller thumbnail used to display meda of the artifact

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV8metadataAA19TzKTBalanceMetadataVSgvp":{"name":"metadata","abstract":"

Metadata object containing useful information about the nft and its contents

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV8isHiddenSbvp":{"name":"isHidden","abstract":"

Recording if the user has marked the token as hidden

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV18favouriteSortIndexSiSgvp":{"name":"favouriteSortIndex","abstract":"

Recording if the position the index the user chose for the favourite token to appear

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV11isFavouriteSbvp":{"name":"isFavourite","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV15fromTzKTBalanceAcA0fG0V_tcfc":{"name":"init(fromTzKTBalance:)","abstract":"

Create a more developer friednly NFT from a generic TzKTBalance object

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Confomring to Equatable

","parent_name":"NFT"},"Structs/NFT.html#/s:14KukaiCoreSwift3NFTV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable

","parent_name":"NFT"},"Structs/NFT.html#/s:s12IdentifiableP2id2IDQzvp":{"name":"id","parent_name":"NFT"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV7xtzPoolAA9XTZAmountCvp":{"name":"xtzPool","abstract":"

The total amount of XTZ in the contract

","parent_name":"LiquidityBakingData"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV9tokenPoolAA11TokenAmountCvp":{"name":"tokenPool","abstract":"

The total amount of the token in the contract (currently tzBTC)

","parent_name":"LiquidityBakingData"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV05totalD0AA11TokenAmountCvp":{"name":"totalLiquidity","abstract":"

The total amount of liquidity tokens in circulation

","parent_name":"LiquidityBakingData"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV20tokenContractAddressSSvp":{"name":"tokenContractAddress","abstract":"

The address of the dex contract

","parent_name":"LiquidityBakingData"},"Structs/LiquidityBakingData.html#/s:14KukaiCoreSwift19LiquidityBakingDataV29liquidityTokenContractAddressSSvp":{"name":"liquidityTokenContractAddress","abstract":"

The address of the liquidty token contract

","parent_name":"LiquidityBakingData"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV2idSSvp":{"name":"id","abstract":"

Uniquie id of the domain

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV7addressSSvp":{"name":"address","abstract":"

The address that the domain points too

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV5ownerSSvp":{"name":"owner","abstract":"

The address that owns the domain

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV12expiresAtUtcSSSgvp":{"name":"expiresAtUtc","abstract":"

Expiration date

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV6domainAA0dE6DomainVvp":{"name":"domain","abstract":"

The domain object continaing the name and address

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecord.html#/s:14KukaiCoreSwift25TezosDomainsReverseRecordV2id7address5owner12expiresAtUtc6domainACSS_S3SSgAA0dE6DomainVtcfc":{"name":"init(id:address:owner:expiresAtUtc:domain:)","abstract":"

Default init

","parent_name":"TezosDomainsReverseRecord"},"Structs/TezosDomainsReverseRecords.html#/s:14KukaiCoreSwift26TezosDomainsReverseRecordsV5itemsACSayAA0deF6RecordVG_tcfc":{"name":"init(items:)","abstract":"

Default init

","parent_name":"TezosDomainsReverseRecords"},"Structs/TezosDomainsDomainBulkResponse.html#/s:14KukaiCoreSwift30TezosDomainsDomainBulkResponseV14reverseRecordsAA0de7ReverseJ0VSgvp":{"name":"reverseRecords","abstract":"

Object containing all the info of the record

","parent_name":"TezosDomainsDomainBulkResponse"},"Structs/TezosDomainsDomainBulkResponse.html#/s:14KukaiCoreSwift30TezosDomainsDomainBulkResponseV14reverseRecordsAcA0de7ReverseJ0VSg_tcfc":{"name":"init(reverseRecords:)","abstract":"

Default init

","parent_name":"TezosDomainsDomainBulkResponse"},"Structs/TezosDomainsDomainResponse.html#/s:14KukaiCoreSwift26TezosDomainsDomainResponseV13reverseRecordAA0de7ReverseI0VSgvp":{"name":"reverseRecord","abstract":"

Object containing all the info of the record

","parent_name":"TezosDomainsDomainResponse"},"Structs/TezosDomainsDomainResponse.html#/s:14KukaiCoreSwift26TezosDomainsDomainResponseV6domainSSSgyF":{"name":"domain()","abstract":"

Helper to extract the domain name more easily

","parent_name":"TezosDomainsDomainResponse"},"Structs/TezosDomainsDomainResponse.html#/s:14KukaiCoreSwift26TezosDomainsDomainResponseV13reverseRecordAcA0de7ReverseI0VSg_tcfc":{"name":"init(reverseRecord:)","abstract":"

Default init

","parent_name":"TezosDomainsDomainResponse"},"Structs/TezosDomainsDomain.html#/s:14KukaiCoreSwift18TezosDomainsDomainV4nameSSvp":{"name":"name","abstract":"

The domain name e.g. example.tez

","parent_name":"TezosDomainsDomain"},"Structs/TezosDomainsDomain.html#/s:14KukaiCoreSwift18TezosDomainsDomainV7addressSSvp":{"name":"address","abstract":"

The Tezos address that the domain points too

","parent_name":"TezosDomainsDomain"},"Structs/TezosDomainsDomain.html#/s:14KukaiCoreSwift18TezosDomainsDomainV4name7addressACSS_SStcfc":{"name":"init(name:address:)","abstract":"

Default init

","parent_name":"TezosDomainsDomain"},"Structs/TezosDomainsAddressResponse.html#/s:14KukaiCoreSwift27TezosDomainsAddressResponseV6domainAA0dE6DomainVvp":{"name":"domain","abstract":"

Domain object containing details about the domain

","parent_name":"TezosDomainsAddressResponse"},"Structs/TezosDomainsAddressResponse.html#/s:14KukaiCoreSwift27TezosDomainsAddressResponseV6domainAcA0dE6DomainV_tcfc":{"name":"init(domain:)","abstract":"

Default init

","parent_name":"TezosDomainsAddressResponse"},"Structs/TezosDomainsDomains.html#/s:14KukaiCoreSwift012TezosDomainsE0V5itemsACSayAA0dE6DomainVG_tcfc":{"name":"init(items:)","abstract":"

Default init

","parent_name":"TezosDomainsDomains"},"Structs/TezosDomainsAddressBulkResponse.html#/s:14KukaiCoreSwift31TezosDomainsAddressBulkResponseV7domainsAA0deE0VSgvp":{"name":"domains","abstract":"

Object containing all the info of the record

","parent_name":"TezosDomainsAddressBulkResponse"},"Structs/TezosDomainsAddressBulkResponse.html#/s:14KukaiCoreSwift31TezosDomainsAddressBulkResponseV7domainsAcA0deE0VSg_tcfc":{"name":"init(domains:)","abstract":"

Default init

","parent_name":"TezosDomainsAddressBulkResponse"},"Structs/ObjktFa.html#/s:14KukaiCoreSwift7ObjktFaV8editionsSo9NSDecimalaSgvp":{"name":"editions","parent_name":"ObjktFa"},"Structs/ObjktFa.html#/s:14KukaiCoreSwift7ObjktFaV11floor_priceSo9NSDecimalaSgvp":{"name":"floor_price","parent_name":"ObjktFa"},"Structs/ObjktEvent.html#/s:14KukaiCoreSwift10ObjktEventV9price_xtzSo9NSDecimalaSgvp":{"name":"price_xtz","parent_name":"ObjktEvent"},"Structs/ObjktListing.html#/s:14KukaiCoreSwift12ObjktListingV14seller_addressSSSgvp":{"name":"seller_address","parent_name":"ObjktListing"},"Structs/ObjktListing.html#/s:14KukaiCoreSwift12ObjktListingV9price_xtzSo9NSDecimalaSgvp":{"name":"price_xtz","parent_name":"ObjktListing"},"Structs/ObjktSale.html#/s:14KukaiCoreSwift9ObjktSaleV9price_xtzSo9NSDecimalaSgvp":{"name":"price_xtz","parent_name":"ObjktSale"},"Structs/ObjktSale.html#/s:14KukaiCoreSwift9ObjktSaleV9timestampSSSgvp":{"name":"timestamp","parent_name":"ObjktSale"},"Structs/ObjktAttributeCounts.html#/s:14KukaiCoreSwift20ObjktAttributeCountsV8editionsSo9NSDecimalavp":{"name":"editions","parent_name":"ObjktAttributeCounts"},"Structs/ObjktAttributeData.html#/s:14KukaiCoreSwift18ObjktAttributeDataV4nameSSvp":{"name":"name","parent_name":"ObjktAttributeData"},"Structs/ObjktAttributeData.html#/s:14KukaiCoreSwift18ObjktAttributeDataV5valueSSvp":{"name":"value","parent_name":"ObjktAttributeData"},"Structs/ObjktAttributeData.html#/s:14KukaiCoreSwift18ObjktAttributeDataV16attribute_countsSayAA0dE6CountsVGvp":{"name":"attribute_counts","parent_name":"ObjktAttributeData"},"Structs/ObjktAttribute.html#/s:14KukaiCoreSwift14ObjktAttributeV9attributeAA0dE4DataVvp":{"name":"attribute","parent_name":"ObjktAttribute"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV13highest_offerSo9NSDecimalaSgvp":{"name":"highest_offer","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV10lowest_askSo9NSDecimalaSgvp":{"name":"lowest_ask","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV8metadataSSSgvp":{"name":"metadata","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV4nameSSSgvp":{"name":"name","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV10attributesSayAA0D9AttributeVGvp":{"name":"attributes","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV13listing_salesSayAA0D4SaleVGvp":{"name":"listing_sales","parent_name":"ObjktToken"},"Structs/ObjktToken.html#/s:14KukaiCoreSwift10ObjktTokenV15listings_activeSayAA0D7ListingVGvp":{"name":"listings_active","parent_name":"ObjktToken"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV5tokenSayAA0dE0VGvp":{"name":"token","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV5eventSayAA0D5EventVGvp":{"name":"event","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV2faSayAA0D2FaVGvp":{"name":"fa","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV8isOnSaleSbyF":{"name":"isOnSale()","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV11onSalePriceAA9XTZAmountCSgyF":{"name":"onSalePrice()","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV13lastSalePriceAA9XTZAmountCSgyF":{"name":"lastSalePrice()","parent_name":"ObjktTokenReponse"},"Structs/ObjktTokenReponse.html#/s:14KukaiCoreSwift17ObjktTokenReponseV10floorPriceAA9XTZAmountCSgyF":{"name":"floorPrice()","parent_name":"ObjktTokenReponse"},"Structs/ObjktCreator.html#/s:14KukaiCoreSwift12ObjktCreatorV7addressSSSgvp":{"name":"address","parent_name":"ObjktCreator"},"Structs/ObjktCreator.html#/s:14KukaiCoreSwift12ObjktCreatorV5aliasSSSgvp":{"name":"alias","parent_name":"ObjktCreator"},"Structs/ObjktCreator.html#/s:14KukaiCoreSwift12ObjktCreatorV7webisteSSSgvp":{"name":"webiste","parent_name":"ObjktCreator"},"Structs/ObjktCreator.html#/s:14KukaiCoreSwift12ObjktCreatorV7twitterSSSgvp":{"name":"twitter","parent_name":"ObjktCreator"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV8contractSSvp":{"name":"contract","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV4nameSSSgvp":{"name":"name","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV4logoSSSgvp":{"name":"logo","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV11floor_priceSo9NSDecimalaSgvp":{"name":"floor_price","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV7twitterSSSgvp":{"name":"twitter","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV7websiteSSSgvp":{"name":"website","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV6ownersSo9NSDecimalaSgvp":{"name":"owners","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV8editionsSo9NSDecimalaSgvp":{"name":"editions","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV7creatorAA0D7CreatorVSgvp":{"name":"creator","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV10websiteURL10Foundation0G0VSgyF":{"name":"websiteURL()","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV10twitterURL10Foundation0G0VSgyF":{"name":"twitterURL()","parent_name":"ObjktCollection"},"Structs/ObjktCollection.html#/s:14KukaiCoreSwift15ObjktCollectionV10floorPriceAA9XTZAmountCSgyF":{"name":"floorPrice()","parent_name":"ObjktCollection"},"Structs/ObjktCollections.html#/s:14KukaiCoreSwift16ObjktCollectionsV2faSayAA0D10CollectionVGvp":{"name":"fa","parent_name":"ObjktCollections"},"Structs/GraphQLResponse.html#/s:14KukaiCoreSwift15GraphQLResponseV6errorsSayAA0D7QLErrorVGSgvp":{"name":"errors","abstract":"

Array of errors returned from the server

","parent_name":"GraphQLResponse"},"Structs/GraphQLResponse.html#/s:14KukaiCoreSwift15GraphQLResponseV4dataxSgvp":{"name":"data","abstract":"

Generic data type matching the user supplied type

","parent_name":"GraphQLResponse"},"Structs/GraphQLError.html#/s:14KukaiCoreSwift12GraphQLErrorV7messageSSvp":{"name":"message","abstract":"

Message sent from the server explaining the issue

","parent_name":"GraphQLError"},"Structs/GraphQLError.html#/s:14KukaiCoreSwift12GraphQLErrorV9locationsSDyS2SGSgvp":{"name":"locations","abstract":"

Identifying the location fo the issue. E.g. codefile and line, or location of unexpected character/symbol in request string

","parent_name":"GraphQLError"},"Structs/GraphQLError.html#/s:14KukaiCoreSwift12GraphQLErrorV11extenstionsSDyS2SGSgvp":{"name":"extenstions","abstract":"

Not sure, but it shows up sometimes

","parent_name":"GraphQLError"},"Structs/FailWithParserLiquidityBaking.html#/s:14KukaiCoreSwift14FailWithParserP5parse04failE0SSSgAA0dE0VSg_tF":{"name":"parse(failWith:)","parent_name":"FailWithParserLiquidityBaking"},"Structs/QuipuswapExchangeUserRewards.html#/s:14KukaiCoreSwift28QuipuswapExchangeUserRewardsV6rewardSSvp":{"name":"reward","abstract":"

Total reward the user has earned

","parent_name":"QuipuswapExchangeUserRewards"},"Structs/QuipuswapExchangeUserRewards.html#/s:14KukaiCoreSwift28QuipuswapExchangeUserRewardsV11reward_paidSSvp":{"name":"reward_paid","abstract":"

Total rewards that have been paid out to the user

","parent_name":"QuipuswapExchangeUserRewards"},"Structs/QuipuswapExchangeUserRewardsKey.html#/s:14KukaiCoreSwift31QuipuswapExchangeUserRewardsKeyV5valueAA0defG0Vvp":{"name":"value","parent_name":"QuipuswapExchangeUserRewardsKey"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV6ledgerSivp":{"name":"ledger","abstract":"

Ledger bigmap id

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV12user_rewardsSivp":{"name":"user_rewards","abstract":"

user rewards bigmap id

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV6rewardSSvp":{"name":"reward","abstract":"

The current reward

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV11reward_paidSSvp":{"name":"reward_paid","abstract":"

The amount of rewards paid out

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV12total_rewardSSvp":{"name":"total_reward","abstract":"

Total reward

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV12total_supplySSvp":{"name":"total_supply","abstract":"

Totoal supply of this token

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV13period_finishSSvp":{"name":"period_finish","abstract":"

Date/Time the period will finish

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV14reward_per_secSSvp":{"name":"reward_per_sec","abstract":"

The reward per second

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV16last_update_timeSSvp":{"name":"last_update_time","abstract":"

Date/Time of the last recorded update to the sotrage

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV16reward_per_shareSSvp":{"name":"reward_per_share","abstract":"

The entitled reward per 1 share owned

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorage.html#/s:14KukaiCoreSwift24QuipuswapExchangeStorageV4date4from10Foundation4DateVSgSS_tF":{"name":"date(from:)","abstract":"

Convert a string to a Date object using Zulu time format

","parent_name":"QuipuswapExchangeStorage"},"Structs/QuipuswapExchangeStorageResponse.html#/s:14KukaiCoreSwift32QuipuswapExchangeStorageResponseV7storageAA0deF0Vvp":{"name":"storage","parent_name":"QuipuswapExchangeStorageResponse"},"Structs/QuipuswapExchangeLedger.html#/s:14KukaiCoreSwift23QuipuswapExchangeLedgerV7balanceSSvp":{"name":"balance","abstract":"

Usable balance of the token owned

","parent_name":"QuipuswapExchangeLedger"},"Structs/QuipuswapExchangeLedger.html#/s:14KukaiCoreSwift23QuipuswapExchangeLedgerV14frozen_balanceSSvp":{"name":"frozen_balance","abstract":"

Currently unaccessible balance of the token owned

","parent_name":"QuipuswapExchangeLedger"},"Structs/QuipuswapExchangeLedgerKey.html#/s:14KukaiCoreSwift26QuipuswapExchangeLedgerKeyV5valueAA0deF0Vvp":{"name":"value","parent_name":"QuipuswapExchangeLedgerKey"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV07primaryE3URL10Foundation0L0VvpZ":{"name":"primaryNodeURL","abstract":"

The default mainnet URL to use for primaryNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV05parseE3URL10Foundation0L0VvpZ":{"name":"parseNodeURL","abstract":"

The default testnet URL to use for parseNodeURL, For more information on Ghostnet, see: https://teztnets.xyz/ghostnet-about","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV7tzktURL10Foundation0L0VvpZ":{"name":"tzktURL","abstract":"

The default testnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV16betterCallDevURL10Foundation0N0VvpZ":{"name":"betterCallDevURL","abstract":"

The default testnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV15tezosDomainsURL10Foundation0M0VvpZ":{"name":"tezosDomainsURL","abstract":"

The default testnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultTestnetURLsV11objktApiURL10Foundation0M0VvpZ":{"name":"objktApiURL","abstract":"

The default testnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

","parent_name":"defaultTestnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV07primaryE3URL10Foundation0L0VvpZ":{"name":"primaryNodeURL","abstract":"

The default mainnet URL to use for primaryNodeURL, For more information on the free service, see: https://tezos.giganode.io/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV05parseE3URL10Foundation0L0VvpZ":{"name":"parseNodeURL","abstract":"

The default mainnet URL to use for parseNodeURL, For more information on the free service, see: https://nautilus.cloud/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV7tzktURL10Foundation0L0VvpZ":{"name":"tzktURL","abstract":"

The default mainnet URL to use for tzktURL, For more information on this service, see: https://api.tzkt.io/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV16betterCallDevURL10Foundation0N0VvpZ":{"name":"betterCallDevURL","abstract":"

The default mainnet URL to use for betterCallDevURL, For more information on this service, see: https://api.better-call.dev/v1/docs/index.html

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV15tezosDomainsURL10Foundation0M0VvpZ":{"name":"tezosDomainsURL","abstract":"

The default mainnet URL to use for tezosDomainsURL, For more information on this service, see: https://tezos.domains/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV18defaultMainnetURLsV11objktApiURL10Foundation0M0VvpZ":{"name":"objktApiURL","abstract":"

The default mainnet URL to use for objktApiURL, For more information on this service, see: https://public-api-v3-20221206.objkt.com/docs/

","parent_name":"defaultMainnetURLs"},"Structs/TezosNodeClientConfig/ForgingType.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11ForgingTypeO5localyA2EmF":{"name":"local","parent_name":"ForgingType"},"Structs/TezosNodeClientConfig/ForgingType.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11ForgingTypeO6remoteyA2EmF":{"name":"remote","parent_name":"ForgingType"},"Structs/TezosNodeClientConfig/NetworkType.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11NetworkTypeO7mainnetyA2EmF":{"name":"mainnet","parent_name":"NetworkType"},"Structs/TezosNodeClientConfig/NetworkType.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11NetworkTypeO7testnetyA2EmF":{"name":"testnet","parent_name":"NetworkType"},"Structs/TezosNodeClientConfig/NetworkType.html":{"name":"NetworkType","abstract":"

An enum indicating whether the network is mainnet or testnet

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig/ForgingType.html":{"name":"ForgingType","abstract":"

Allow switching between local forging or remote forging+parsing

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig/defaultMainnetURLs.html":{"name":"defaultMainnetURLs","abstract":"

Preconfigured struct with all the URL’s needed to work with Tezos mainnet

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig/defaultTestnetURLs.html":{"name":"defaultTestnetURLs","abstract":"

Preconfigured struct with all the URL’s needed to work with Tezos testnet

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV07primaryE3URL10Foundation0I0Vvp":{"name":"primaryNodeURL","abstract":"

The main URL used for remote forging, fetching balances, setting delegates and other forms of queries and operations.

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV05parseE3URL10Foundation0I0VSgvp":{"name":"parseNodeURL","abstract":"

When using remote forging, it is essential to use a second server to verify the contents of the remote forge match what the library sent.

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11forgingTypeAC07ForgingI0Ovp":{"name":"forgingType","abstract":"

Controls whether to use local forging or remote forging+parsing

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV7tzktURL10Foundation0I0Vvp":{"name":"tzktURL","abstract":"

The URL to use for TzKTClient

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV16betterCallDevURL10Foundation0K0Vvp":{"name":"betterCallDevURL","abstract":"

The URL to use for BetterCallDevClient

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV15tezosDomainsURL10Foundation0J0Vvp":{"name":"tezosDomainsURL","abstract":"

The URL to use for TezosDomainsClient

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11objktApiURL10Foundation0J0Vvp":{"name":"objktApiURL","abstract":"

The URL to use for TezosDomainsClient

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV10urlSessionSo12NSURLSessionCvp":{"name":"urlSession","abstract":"

The URLSession that will be used for all network communication. If looking to mock this library, users should create their own URLSessionMock and pass it in.

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV11networkTypeAC07NetworkI0Ovp":{"name":"networkType","abstract":"

The network type of the connected node

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV07loggingG0AA07LoggingG0Vvp":{"name":"loggingConfig","abstract":"

Control what gets logged to the console

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV26withDefaultsForNetworkTypeA2C0kL0O_tcfc":{"name":"init(withDefaultsForNetworkType:)","abstract":"

Init a TezosNodeClientConfig with the defaults

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV20configWithLocalForge07primaryE3URL04tzktM0013betterCallDevM0012tezosDomainsM008objktApiM010urlSession11networkTypeAC10Foundation0M0V_A4NSo12NSURLSessionCAC07NetworkY0OtFZ":{"name":"configWithLocalForge(primaryNodeURL:tzktURL:betterCallDevURL:tezosDomainsURL:objktApiURL:urlSession:networkType:)","abstract":"

Creates an instance of TezosNodeClientConfig with only the required properties needed when using local forge.

","parent_name":"TezosNodeClientConfig"},"Structs/TezosNodeClientConfig.html#/s:14KukaiCoreSwift21TezosNodeClientConfigV21configWithRemoteForge07primaryE3URL05parseeM004tzktM0013betterCallDevM0012tezosDomainsM008objktApiM010urlSession11networkTypeAC10Foundation0M0V_A5OSo12NSURLSessionCAC07NetworkZ0OtFZ":{"name":"configWithRemoteForge(primaryNodeURL:parseNodeURL:tzktURL:betterCallDevURL:tezosDomainsURL:objktApiURL:urlSession:networkType:)","abstract":"

Creates an instance of TezosNodeClientConfig with the required properties for remote forging. Note: function will casue a fatalError is users attempt to set primaryNodeURL and parseNodeURL to the same destination

","parent_name":"TezosNodeClientConfig"},"Structs/LoggingConfig.html#/s:14KukaiCoreSwift13LoggingConfigV6allOffyyF":{"name":"allOff()","abstract":"

Turn off all logging

","parent_name":"LoggingConfig"},"Structs/LoggingConfig.html#/s:14KukaiCoreSwift13LoggingConfigV5allOnyyF":{"name":"allOn()","parent_name":"LoggingConfig"},"Structs/BlockchainHead.html#/s:14KukaiCoreSwift14BlockchainHeadV8protocolSSvp":{"name":"protocol","abstract":"

The current protocol version string

","parent_name":"BlockchainHead"},"Structs/BlockchainHead.html#/s:14KukaiCoreSwift14BlockchainHeadV7chainIDSSvp":{"name":"chainID","abstract":"

The current chainID being used

","parent_name":"BlockchainHead"},"Structs/BlockchainHead.html#/s:14KukaiCoreSwift14BlockchainHeadV4hashSSvp":{"name":"hash","abstract":"

The current hash or branch being used

","parent_name":"BlockchainHead"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV9groupTypeAA0dE0V014TransactionSubH0Ovp":{"name":"groupType","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV4hashSSvp":{"name":"hash","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV12transactionsSayAA0dE0VGvp":{"name":"transactions","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV6statusAA0dE0V17TransactionStatusOvp":{"name":"status","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV12primaryTokenAA0H0CSgvp":{"name":"primaryToken","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV14secondaryTokenAA0H0CSgvp":{"name":"secondaryToken","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV16entrypointCalledSSSgvp":{"name":"entrypointCalled","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:s12IdentifiableP2id2IDQzvp":{"name":"id","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:14KukaiCoreSwift20TzKTTransactionGroupV16withTransactions20currentWalletAddressACSgSayAA0dE0VG_SStcfc":{"name":"init(withTransactions:currentWalletAddress:)","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransactionGroup.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"TzKTTransactionGroup"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO4typeyA2EmF":{"name":"type","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO2idyA2EmF":{"name":"id","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO5levelyA2EmF":{"name":"level","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO9timestampyA2EmF":{"name":"timestamp","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO4hashyA2EmF":{"name":"hash","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO7counteryA2EmF":{"name":"counter","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO9initiateryA2EmF":{"name":"initiater","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6senderyA2EmF":{"name":"sender","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO8bakerFeeyA2EmF":{"name":"bakerFee","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO10storageFeeyA2EmF":{"name":"storageFee","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO13allocationFeeyA2EmF":{"name":"allocationFee","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6targetyA2EmF":{"name":"target","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO12prevDelegateyA2EmF":{"name":"prevDelegate","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO11newDelegateyA2EmF":{"name":"newDelegate","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6amountyA2EmF":{"name":"amount","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO9parameteryA2EmF":{"name":"parameter","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6statusyA2EmF":{"name":"status","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO7subTypeyA2EmF":{"name":"subType","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO16entrypointCalledyA2EmF":{"name":"entrypointCalled","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO12primaryTokenyA2EmF":{"name":"primaryToken","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO12hasInternalsyA2EmF":{"name":"hasInternals","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO19tokenTransfersCountyA2EmF":{"name":"tokenTransfersCount","parent_name":"CodingKeys"},"Structs/TzKTTransaction/CodingKeys.html#/s:14KukaiCoreSwift15TzKTTransactionV10CodingKeysO6errorsyA2EmF":{"name":"errors","parent_name":"CodingKeys"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO4sendyA2EmF":{"name":"send","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO7receiveyA2EmF":{"name":"receive","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO8delegateyA2EmF":{"name":"delegate","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO6revealyA2EmF":{"name":"reveal","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO8exchangeyA2EmF":{"name":"exchange","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO12contractCallyA2EmF":{"name":"contractCall","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionSubType.html#/s:14KukaiCoreSwift15TzKTTransactionV18TransactionSubTypeO7unknownyA2EmF":{"name":"unknown","parent_name":"TransactionSubType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO10delegationyA2EmF":{"name":"delegation","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO11originationyA2EmF":{"name":"origination","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO11transactionyA2EmF":{"name":"transaction","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO6revealyA2EmF":{"name":"reveal","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionType.html#/s:14KukaiCoreSwift15TzKTTransactionV15TransactionTypeO7unknownyA2EmF":{"name":"unknown","parent_name":"TransactionType"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO7appliedyA2EmF":{"name":"applied","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO6failedyA2EmF":{"name":"failed","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO11backtrackedyA2EmF":{"name":"backtracked","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO11unconfirmedyA2EmF":{"name":"unconfirmed","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO18partiallyConfirmedyA2EmF":{"name":"partiallyConfirmed","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO9confirmedyA2EmF":{"name":"confirmed","parent_name":"TransactionStatus"},"Structs/TzKTTransaction/TransactionStatus.html#/s:14KukaiCoreSwift15TzKTTransactionV17TransactionStatusO7unknownyA2EmF":{"name":"unknown","parent_name":"TransactionStatus"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV13dateFormatterSo06NSDateG0CvpZ":{"name":"dateFormatter","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction/TransactionStatus.html":{"name":"TransactionStatus","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction/TransactionType.html":{"name":"TransactionType","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction/TransactionSubType.html":{"name":"TransactionSubType","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV16TransactionErrorV":{"name":"TransactionError","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4typeAC15TransactionTypeOvp":{"name":"type","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:s12IdentifiableP2id2IDQzvp":{"name":"id","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV5levelSo9NSDecimalavp":{"name":"level","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV9timestampSSvp":{"name":"timestamp","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4hashSSvp":{"name":"hash","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV7counterSo9NSDecimalavp":{"name":"counter","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV9initiaterAA0D9KTAddressVSgvp":{"name":"initiater","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6senderAA0D9KTAddressVvp":{"name":"sender","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV8bakerFeeAA9XTZAmountCvp":{"name":"bakerFee","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV10storageFeeAA9XTZAmountCvp":{"name":"storageFee","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV13allocationFeeAA9XTZAmountCvp":{"name":"allocationFee","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6targetAA0D9KTAddressVSgvp":{"name":"target","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV12prevDelegateAA0D9KTAddressVSgvp":{"name":"prevDelegate","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV11newDelegateAA0D9KTAddressVSgvp":{"name":"newDelegate","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6amountAA11TokenAmountCvp":{"name":"amount","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV9parameterSDyS2SGSgvp":{"name":"parameter","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6statusAC17TransactionStatusOvp":{"name":"status","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV12hasInternalsSbvp":{"name":"hasInternals","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV19tokenTransfersCountSo9NSDecimalaSgvp":{"name":"tokenTransfersCount","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV6errorsSayAC16TransactionErrorVGSgvp":{"name":"errors","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4date10Foundation4DateVSgvp":{"name":"date","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV17tzktTokenTransferAA0d7KTTokenH0VSgvp":{"name":"tzktTokenTransfer","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV7subTypeAC014TransactionSubG0OSgvp":{"name":"subType","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV16entrypointCalledSSSgvp":{"name":"entrypointCalled","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV12primaryTokenAA0G0CSgvp":{"name":"primaryToken","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction/CodingKeys.html":{"name":"CodingKeys","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4type2id5level9timestamp4hash7counter9initiater6sender8bakerFee07storageO0010allocationO06target12prevDelegate03newT06amount9parameter6status12hasInternals19tokenTransfersCount6errorsA2C15TransactionTypeO_So9NSDecimalaA_S2SA_AA0D9KTAddressVSgA1_AA9XTZAmountCA4_A4_A2_A2_A2_AA11TokenAmountCSDyS2SGSgAC17TransactionStatusOSbA_SgSayAC16TransactionErrorVGSgtcfc":{"name":"init(type:id:level:timestamp:hash:counter:initiater:sender:bakerFee:storageFee:allocationFee:target:prevDelegate:newDelegate:amount:parameter:status:hasInternals:tokenTransfersCount:errors:)","abstract":"

Manually init a TzKTTransaction

","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV4fromAcA0D15KTTokenTransferV_tcfc":{"name":"init(from:)","abstract":"

Convert a TzKTTokenTransfer into a TzKTTransaction

","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV11placeholder10withStatus6opHash4type7counter10fromWallet11destination9xtzAmount10parameters12primaryTokenA2C011TransactionH0O_SSAC0U4TypeOSo9NSDecimalaAA0N8MetadataVAA0D9KTAddressVAA0tQ0CSDyS2SGSgAA0T0CSgtFZ":{"name":"placeholder(withStatus:opHash:type:counter:fromWallet:destination:xtzAmount:parameters:primaryToken:)","abstract":"

Used for creating “Pending” transactions

","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV11placeholder10withStatus6opHash4type7counter10fromWallet11newDelegateA2C011TransactionH0O_SSAC0Q4TypeOSo9NSDecimalaAA0N8MetadataVAA0D9KTAddressVSgtFZ":{"name":"placeholder(withStatus:opHash:type:counter:fromWallet:newDelegate:)","abstract":"

Used for createing a “Pending” delegation transaction

","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV21parameterValueAsArraySayypGSgyF":{"name":"parameterValueAsArray()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV20parameterValueAsDictSDySSypGSgyF":{"name":"parameterValueAsDict()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV33parameterValueAsArrayOfDictionarySaySDySSypGGSgyF":{"name":"parameterValueAsArrayOfDictionary()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV20parameterValueAsType4typexSgxm_tlF":{"name":"parameterValueAsType(type:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV13getEntrypointSSSgyF":{"name":"getEntrypoint()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV21processAdditionalData24withCurrentWalletAddressySS_tF":{"name":"processAdditionalData(withCurrentWalletAddress:)","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV18createPrimaryTokenAA0H0CSgyF":{"name":"createPrimaryToken()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV22getFaTokenTransferDataAA0H0CSgyF":{"name":"getFaTokenTransferData()","abstract":"

The TzKT transaction API doesn’t provide all the info needed to normalise Token amounts. It only gives address and rpc amount.","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV27getTokenTransferDestinationSSSgyF":{"name":"getTokenTransferDestination()","parent_name":"TzKTTransaction"},"Structs/TzKTTransaction.html#/s:14KukaiCoreSwift15TzKTTransactionV11errorStringSSSgyF":{"name":"errorString()","parent_name":"TzKTTransaction"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV2idSo9NSDecimalavp":{"name":"id","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV4hashSSSgvp":{"name":"hash","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV5levelSo9NSDecimalavp":{"name":"level","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV9timestampSSvp":{"name":"timestamp","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV5tokenAA0D14KTBalanceTokenVvp":{"name":"token","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV2toAA0D9KTAddressVSgvp":{"name":"to","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV4fromAA0D9KTAddressVSgvp":{"name":"from","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV6amountSSvp":{"name":"amount","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV13transactionIdSo9NSDecimalavp":{"name":"transactionId","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV11mintingToolSSSgvp":{"name":"mintingTool","parent_name":"TzKTTokenTransfer"},"Structs/TzKTTokenTransfer.html#/s:14KukaiCoreSwift17TzKTTokenTransferV11tokenAmountAA05TokenH0CyF":{"name":"tokenAmount()","parent_name":"TzKTTokenTransfer"},"Structs/TzKTOperationError.html#/s:14KukaiCoreSwift18TzKTOperationErrorV4typeSSvp":{"name":"type","abstract":"

The RPC error type string

","parent_name":"TzKTOperationError"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV4typeSSvp":{"name":"type","abstract":"

Type of operation (e.g. transaction, delegation, reveal etc)

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV2idSivp":{"name":"id","abstract":"

Unique id to denote the operation

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV5levelSivp":{"name":"level","abstract":"

The block level it was injected at

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV9timestampSSvp":{"name":"timestamp","abstract":"

Timestamp it was injected at

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV5blockSSvp":{"name":"block","abstract":"

The hash of the injected block

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV4hashSSvp":{"name":"hash","abstract":"

The operation hash

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV7counterSivp":{"name":"counter","abstract":"

The users numerical counter of the operation

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV6statusSSvp":{"name":"status","abstract":"

Status of the operation (e.g. applied or failed)

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV6errorsSayAA0dE5ErrorVGSgvp":{"name":"errors","abstract":"

Optional array of errors encountered while trying to inject the operation

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV8isFailedSbyF":{"name":"isFailed()","abstract":"

Helper to detect a failed transation by searching for a status of “failed”, “backtracked” or “skipped”

","parent_name":"TzKTOperation"},"Structs/TzKTOperation.html#/s:14KukaiCoreSwift13TzKTOperationV13containsErrorSbyF":{"name":"containsError()","abstract":"

Helper to detect if this operation contains an error

","parent_name":"TzKTOperation"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV5cycleSivp":{"name":"cycle","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV7balanceSo9NSDecimalavp":{"name":"balance","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV5bakerAA0D9KTAddressVvp":{"name":"baker","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV14stakingBalanceSo9NSDecimalavp":{"name":"stakingBalance","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV12blockRewardsSo9NSDecimalavp":{"name":"blockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV18missedBlockRewardsSo9NSDecimalavp":{"name":"missedBlockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV18endorsementRewardsSo9NSDecimalavp":{"name":"endorsementRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV24missedEndorsementRewardsSo9NSDecimalavp":{"name":"missedEndorsementRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV9blockFeesSo9NSDecimalavp":{"name":"blockFees","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV15missedBlockFeesSo9NSDecimalavp":{"name":"missedBlockFees","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV17extraBlockRewardsSo9NSDecimalavp":{"name":"extraBlockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV23missedExtraBlockRewardsSo9NSDecimalavp":{"name":"missedExtraBlockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV18futureBlockRewardsSo9NSDecimalavp":{"name":"futureBlockRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV24futureEndorsementRewardsSo9NSDecimalavp":{"name":"futureEndorsementRewards","parent_name":"TzKTDelegatorReward"},"Structs/TzKTDelegatorReward.html#/s:14KukaiCoreSwift19TzKTDelegatorRewardV09estimatedF07withFee03andF6StructAA9XTZAmountCSd_AA0d13KTBakerConfigfK0VSgtF":{"name":"estimatedReward(withFee:andRewardStruct:)","abstract":"

Return an estimated either for potential future or actual rewards

","parent_name":"TzKTDelegatorReward"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV9startTimeSSvp":{"name":"startTime","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV10firstLevelSo9NSDecimalavp":{"name":"firstLevel","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV7endTimeSSvp":{"name":"endTime","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV9lastLevelSo9NSDecimalavp":{"name":"lastLevel","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV9stateDate10Foundation0G0VSgvp":{"name":"stateDate","parent_name":"TzKTCycle"},"Structs/TzKTCycle.html#/s:14KukaiCoreSwift9TzKTCycleV7endDate10Foundation0G0VSgvp":{"name":"endDate","parent_name":"TzKTCycle"},"Structs/TzKTBalanceMetadataDimensions.html#/s:14KukaiCoreSwift29TzKTBalanceMetadataDimensionsV4unitSSSgvp":{"name":"unit","abstract":"

The unit of measurement (e.g. px for pixels)

","parent_name":"TzKTBalanceMetadataDimensions"},"Structs/TzKTBalanceMetadataDimensions.html#/s:14KukaiCoreSwift29TzKTBalanceMetadataDimensionsV5valueSSSgvp":{"name":"value","abstract":"

String containing the resolution or size (e.g. 1024x787)

","parent_name":"TzKTBalanceMetadataDimensions"},"Structs/TzKTBalanceMetadataDimensions.html#/s:14KukaiCoreSwift29TzKTBalanceMetadataDimensionsV4unit5valueACSS_SStcfc":{"name":"init(unit:value:)","abstract":"

Init to manaually create an instance, mostly for testing

","parent_name":"TzKTBalanceMetadataDimensions"},"Structs/TzKTBalanceMetadataFormat.html#/s:14KukaiCoreSwift25TzKTBalanceMetadataFormatV3uriSSvp":{"name":"uri","abstract":"

The URI to this specific format

","parent_name":"TzKTBalanceMetadataFormat"},"Structs/TzKTBalanceMetadataFormat.html#/s:14KukaiCoreSwift25TzKTBalanceMetadataFormatV8mimeTypeSSvp":{"name":"mimeType","abstract":"

The mimetype of this version

","parent_name":"TzKTBalanceMetadataFormat"},"Structs/TzKTBalanceMetadataFormat.html#/s:14KukaiCoreSwift25TzKTBalanceMetadataFormatV10dimensionsAA0deF10DimensionsVSgvp":{"name":"dimensions","abstract":"

The display dimensions

","parent_name":"TzKTBalanceMetadataFormat"},"Structs/TzKTBalanceMetadataFormat.html#/s:14KukaiCoreSwift25TzKTBalanceMetadataFormatV3uri8mimeType10dimensionsACSS_SSAA0deF10DimensionsVSgtcfc":{"name":"init(uri:mimeType:dimensions:)","abstract":"

Init to manaually create an instance, mostly for testing

","parent_name":"TzKTBalanceMetadataFormat"},"Structs/TzKTBalanceMetadataAttributeKeyValue.html#/s:14KukaiCoreSwift36TzKTBalanceMetadataAttributeKeyValueV3keySSvp":{"name":"key","parent_name":"TzKTBalanceMetadataAttributeKeyValue"},"Structs/TzKTBalanceMetadataAttributeKeyValue.html#/s:14KukaiCoreSwift36TzKTBalanceMetadataAttributeKeyValueV5valueSSvp":{"name":"value","parent_name":"TzKTBalanceMetadataAttributeKeyValue"},"Structs/TzKTBalanceMetadataAttributeKeyValue.html#/s:14KukaiCoreSwift36TzKTBalanceMetadataAttributeKeyValueV3key5valueACSS_SStcfc":{"name":"init(key:value:)","parent_name":"TzKTBalanceMetadataAttributeKeyValue"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV4nameSSSgvp":{"name":"name","abstract":"

A human readbale name

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV6symbolSSSgvp":{"name":"symbol","abstract":"

The tokens symbol

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV8decimalsSSvp":{"name":"decimals","abstract":"

The number of decimals the token has

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV11decimalsIntSivp":{"name":"decimalsInt","abstract":"

Helper to convert the decimals to an Int

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV7formatsSayAA0deF6FormatVGSgvp":{"name":"formats","abstract":"

Details of the available formats that the media is available in

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV10displayUriSSSgvp":{"name":"displayUri","abstract":"

URI to an medium/large image owned by the contract

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV11artifactUriSSSgvp":{"name":"artifactUri","abstract":"

URI to the raw media artifact owned by the token

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV12thumbnailUriSSSgvp":{"name":"thumbnailUri","abstract":"

URI to an small image for the token, ususally used as an icon when displayed in lists

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV11descriptionSSSgvp":{"name":"description","abstract":"

Description of the token or NFT

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV11mintingToolSSSgvp":{"name":"mintingTool","abstract":"

URL to the tool that was used to mint the item

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV4tagsSaySSGSgvp":{"name":"tags","abstract":"

A list of tags to categorize the token / NFT

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV6minterSSSgvp":{"name":"minter","abstract":"

The address responsible for creating the token / NFT

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV18shouldPreferSymbolSbSgvp":{"name":"shouldPreferSymbol","abstract":"

Whether or not the symbol or the name is prefered when displaying the token / NFT in a list

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV10attributesSayypGSgvp":{"name":"attributes","abstract":"

A collection of attributes about the token/NFT. Although TZIP-16 intended for this to be filled with info such as license, version, possible error messages etc,","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV3ttlSiSgvp":{"name":"ttl","abstract":"

Flag, in seconds, indicating how long to wait before refreshing the token to update its metadata. E.g. fxHash will inject a token with a name “[Waiting to be Signed]”. and then, all things going well, 30 seconds later its updated to the correct attributes

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV4name6symbol8decimals7formats10displayUri08artifactL009thumbnailL011description11mintingTool4tags6minter18shouldPreferSymbol10attributes3ttlACSSSg_ARSSSayAA0deF6FormatVGSgA5RSaySSGSgARSbSgSayypGSgSiSgtcfc":{"name":"init(name:symbol:decimals:formats:displayUri:artifactUri:thumbnailUri:description:mintingTool:tags:minter:shouldPreferSymbol:attributes:ttl:)","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV12thumbnailURL10Foundation0H0VSgvp":{"name":"thumbnailURL","abstract":"

Helper to run the URI through the MediaProxyService to generate a useable URL for the thumbnail (if available)

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV10displayURL10Foundation0H0VSgvp":{"name":"displayURL","abstract":"

Helper to run the URI through the MediaProxyService to generate a useable URL for the display image (if available)

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceMetadata.html#/s:14KukaiCoreSwift19TzKTBalanceMetadataV26getKeyValuesFromAttributesSayAA0def9AttributeH5ValueVGyF":{"name":"getKeyValuesFromAttributes()","abstract":"

Attributes is a complex free-form object. In a lot of cases when NFT’s are games / collectibles, it should be possible to convert most if not all the elements into more simple String: String key value pairs, which will be easier to manage in table / collection views

","parent_name":"TzKTBalanceMetadata"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV8contractAA0D9KTAddressVvp":{"name":"contract","abstract":"

Details of the contract (e.g. address)

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV7tokenIdSSvp":{"name":"tokenId","abstract":"

The FA2 token ID of the token

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV8standardAA9FaVersionOvp":{"name":"standard","abstract":"

Which FA version the token conforms too

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV11totalSupplySSSgvp":{"name":"totalSupply","abstract":"

Total avaialble supply of this address + token id combo

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV8metadataAA0dE8MetadataVSgvp":{"name":"metadata","abstract":"

Metadata about the token

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV17malformedMetadataSbvp":{"name":"malformedMetadata","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV13displaySymbolSSvp":{"name":"displaySymbol","abstract":"

Helper to determine what string is used as the symbol for display purposes

","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:14KukaiCoreSwift16TzKTBalanceTokenV8contract7tokenId8standard11totalSupply8metadataAcA0D9KTAddressV_SSAA9FaVersionOSSSgAA0dE8MetadataVSgtcfc":{"name":"init(contract:tokenId:standard:totalSupply:metadata:)","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalanceToken.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"TzKTBalanceToken"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV16exceptionListNFTSaySSGvpZ":{"name":"exceptionListNFT","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV7balanceSSvp":{"name":"balance","abstract":"

String containing the RPC respresetnation of the balance of the given token

","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV5tokenAA0dE5TokenVvp":{"name":"token","abstract":"

Details about the Token

","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV11tokenAmountAA05TokenG0Cvp":{"name":"tokenAmount","abstract":"

Helper to convert the RPC token balance to a TokenAmount object

","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV5isNFTSbyF":{"name":"isNFT()","abstract":"

Basic check to see if token is an NFT or not. May not be 100% successful, needs research

","parent_name":"TzKTBalance"},"Structs/TzKTBalance.html#/s:14KukaiCoreSwift11TzKTBalanceV20isOnNFTExceptionListSbyF":{"name":"isOnNFTExceptionList()","parent_name":"TzKTBalance"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV6blocksSbvp":{"name":"blocks","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV12missedBlocksSbvp":{"name":"missedBlocks","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV12endorsementsSbvp":{"name":"endorsements","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV18missedEndorsementsSbvp":{"name":"missedEndorsements","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV4feesSbvp":{"name":"fees","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV10missedFeesSbvp":{"name":"missedFees","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV17accusationRewardsSbvp":{"name":"accusationRewards","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV16accusationLossesSbvp":{"name":"accusationLosses","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV17revelationRewardsSbvp":{"name":"revelationRewards","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV16revelationLossesSbvp":{"name":"revelationLosses","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigRewardStruct.html#/s:14KukaiCoreSwift27TzKTBakerConfigRewardStructV04fromF3IntyACSiFZ":{"name":"fromConfigInt(_:)","abstract":"

Convert the 14-bit number in the baker config, to the equivalent set of flags

","parent_name":"TzKTBakerConfigRewardStruct"},"Structs/TzKTBakerConfigIntValue.html#/s:14KukaiCoreSwift23TzKTBakerConfigIntValueV5cycleSivp":{"name":"cycle","parent_name":"TzKTBakerConfigIntValue"},"Structs/TzKTBakerConfigIntValue.html#/s:14KukaiCoreSwift23TzKTBakerConfigIntValueV5valueSivp":{"name":"value","parent_name":"TzKTBakerConfigIntValue"},"Structs/TzKTBakerConfigDoubleValue.html#/s:14KukaiCoreSwift26TzKTBakerConfigDoubleValueV5cycleSivp":{"name":"cycle","parent_name":"TzKTBakerConfigDoubleValue"},"Structs/TzKTBakerConfigDoubleValue.html#/s:14KukaiCoreSwift26TzKTBakerConfigDoubleValueV5valueSdvp":{"name":"value","parent_name":"TzKTBakerConfigDoubleValue"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV7addressSSvp":{"name":"address","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV3feeSayAA0deF11DoubleValueVGvp":{"name":"fee","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV13minDelegationSayAA0deF11DoubleValueVGvp":{"name":"minDelegation","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV11payoutDelaySayAA0deF8IntValueVGvp":{"name":"payoutDelay","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV12rewardStructSayAA0deF8IntValueVGvp":{"name":"rewardStruct","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV10latesetFeeSdyF":{"name":"latesetFee()","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV11feeForCycle5cycleSdSi_tF":{"name":"feeForCycle(cycle:)","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV17latestPayoutDelaySiyF":{"name":"latestPayoutDelay()","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV19payoutDelayForCycle5cycleS2i_tF":{"name":"payoutDelayForCycle(cycle:)","parent_name":"TzKTBakerConfig"},"Structs/TzKTBakerConfig.html#/s:14KukaiCoreSwift15TzKTBakerConfigV18latestRewardStructSiSgyF":{"name":"latestRewardStruct()","parent_name":"TzKTBakerConfig"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV7addressSSvp":{"name":"address","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV4nameSSSgvp":{"name":"name","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV4logoSSSgvp":{"name":"logo","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV7balanceSo9NSDecimalavp":{"name":"balance","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV14stakingBalanceSo9NSDecimalavp":{"name":"stakingBalance","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV15stakingCapacitySo9NSDecimalavp":{"name":"stakingCapacity","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV17maxStakingBalanceSo9NSDecimalavp":{"name":"maxStakingBalance","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV9freeSpaceSo9NSDecimalavp":{"name":"freeSpace","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV3feeSdvp":{"name":"fee","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV13minDelegationSo9NSDecimalavp":{"name":"minDelegation","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV11payoutDelaySivp":{"name":"payoutDelay","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV12payoutPeriodSivp":{"name":"payoutPeriod","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV17openForDelegationSbvp":{"name":"openForDelegation","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV12estimatedRoiSo9NSDecimalavp":{"name":"estimatedRoi","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV13serviceHealthAA0deG0Ovp":{"name":"serviceHealth","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV12payoutTimingAA0deG0Ovp":{"name":"payoutTiming","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV14payoutAccuracyAA0deG0Ovp":{"name":"payoutAccuracy","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV6configAA0dE6ConfigVSgvp":{"name":"config","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV7address4name4logoACSS_SSSgAGtcfc":{"name":"init(address:name:logo:)","abstract":"

Helper to create a TzKTBaker from the data available from the Account object

","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV7address4name4logo7balance14stakingBalance0J8Capacity010maxStakingK09freeSpace3fee13minDelegation11payoutDelay0T6Period07openForS012estimatedRoi13serviceHealth0T6Timing0T8Accuracy6configACSS_SSSgAVSo9NSDecimalaA4XSdAXS2iSbAxA0dE6HealthOAA0dE6TimingOAA0dE8AccuracyOAA0dE6ConfigVSgtcfc":{"name":"init(address:name:logo:balance:stakingBalance:stakingCapacity:maxStakingBalance:freeSpace:fee:minDelegation:payoutDelay:payoutPeriod:openForDelegation:estimatedRoi:serviceHealth:payoutTiming:payoutAccuracy:config:)","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV16fromTestnetArrayyACSgSayypGFZ":{"name":"fromTestnetArray(_:)","abstract":"

Ghostnet has a different setup for bakers, but we need to display and interact with them the same way.","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:14KukaiCoreSwift9TzKTBakerV12rewardStructAA0de12ConfigRewardG0VSgyF":{"name":"rewardStruct()","abstract":"

Convert con-chain data into a meaningful, readable object

","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"TzKTBaker"},"Structs/TzKTBaker.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"TzKTBaker"},"Structs/TzKTAddress.html#/s:14KukaiCoreSwift11TzKTAddressV5aliasSSSgvp":{"name":"alias","abstract":"

Contract addresses may have an alias (human readbale) name, to denote a person or service

","parent_name":"TzKTAddress"},"Structs/TzKTAddress.html#/s:14KukaiCoreSwift11TzKTAddressV7addressSSvp":{"name":"address","abstract":"

The KT1 address of the contract

","parent_name":"TzKTAddress"},"Structs/TzKTAddress.html#/s:14KukaiCoreSwift11TzKTAddressV5alias7addressACSSSg_SStcfc":{"name":"init(alias:address:)","parent_name":"TzKTAddress"},"Structs/TzKTAccountDelegate.html#/s:14KukaiCoreSwift19TzKTAccountDelegateV5aliasSSSgvp":{"name":"alias","abstract":"

Bakers may have an alias (human readbale) name for their service

","parent_name":"TzKTAccountDelegate"},"Structs/TzKTAccountDelegate.html#/s:14KukaiCoreSwift19TzKTAccountDelegateV7addressSSvp":{"name":"address","abstract":"

Bakers must have a valid address

","parent_name":"TzKTAccountDelegate"},"Structs/TzKTAccountDelegate.html#/s:14KukaiCoreSwift19TzKTAccountDelegateV6activeSbvp":{"name":"active","abstract":"

Bool indicating whether or not the baker is currently active

","parent_name":"TzKTAccountDelegate"},"Structs/TzKTAccountDelegate.html#/s:14KukaiCoreSwift19TzKTAccountDelegateV5alias7address6activeACSSSg_SSSbtcfc":{"name":"init(alias:address:active:)","parent_name":"TzKTAccountDelegate"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV7balanceSo9NSDecimalaSgvp":{"name":"balance","abstract":"

The address XTZ balance in RPC format

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV4typeSSvp":{"name":"type","abstract":"

type of account e.g. “user” or “empty”

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV7addressSSvp":{"name":"address","abstract":"

tz1/2/3 kt1 address

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV9publicKeySSSgvp":{"name":"publicKey","abstract":"

prefixed public key

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV8revealedSbSgvp":{"name":"revealed","abstract":"

whether or not the account has performed a reveal operation

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV8delegateAA0dE8DelegateVSgvp":{"name":"delegate","abstract":"

The addresses delegation status

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV15delegationLevelSo9NSDecimalaSgvp":{"name":"delegationLevel","abstract":"

The block level the delegate address was set

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV17activeTokensCountSo9NSDecimalaSgvp":{"name":"activeTokensCount","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV18tokenBalancesCountSo9NSDecimalaSgvp":{"name":"tokenBalancesCount","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV10xtzBalanceAA9XTZAmountCvp":{"name":"xtzBalance","abstract":"

Helper method to convert the RPC balance into an XTZAmount

","parent_name":"TzKTAccount"},"Structs/TzKTAccount.html#/s:14KukaiCoreSwift11TzKTAccountV7balance4type7address9publicKey8revealed8delegate15delegationLevel17activeTokensCount013tokenBalancesQ0ACSo9NSDecimalaSg_S3SSbAA0dE8DelegateVSgA3Otcfc":{"name":"init(balance:type:address:publicKey:revealed:delegate:delegationLevel:activeTokensCount:tokenBalancesCount:)","abstract":"

Generic init

","parent_name":"TzKTAccount"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV6symbolSSvp":{"name":"symbol","abstract":"

The user facing symbol of the token

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV7addressSSvp":{"name":"address","abstract":"

The TZ address of the token

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV7tokenIdSo9NSDecimalavp":{"name":"tokenId","abstract":"

The token ID of the token (always 0 for FA1.2 tokens)

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV8decimalsSivp":{"name":"decimals","abstract":"

The number of decimals for the token

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV8standardAA0deF8StandardOvp":{"name":"standard","abstract":"

Which standard the token follows

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupToken"},"Structs/DipDupToken.html#/s:14KukaiCoreSwift11DipDupTokenV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupToken"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV9sharesQtySSvp":{"name":"sharesQty","abstract":"

The liquidity token balance (rpc representation)

","parent_name":"DipDupPositionData"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV8exchangeAA0dE8ExchangeVvp":{"name":"exchange","abstract":"

The exchange the token belongs too

","parent_name":"DipDupPositionData"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV11tokenAmountAA05TokenI0CyF":{"name":"tokenAmount()","abstract":"

Convert the token data into a TokenAmount

","parent_name":"DipDupPositionData"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupPositionData"},"Structs/DipDupPositionData.html#/s:14KukaiCoreSwift18DipDupPositionDataV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupPositionData"},"Structs/DipDupPosition.html#/s:14KukaiCoreSwift14DipDupPositionV8positionSayAA0deF4DataVGvp":{"name":"position","parent_name":"DipDupPosition"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV4nameAA0deF4NameOvp":{"name":"name","abstract":"

Enum to denote the type of Exchange (e.g. Liquidity Baking, Quipuswap)

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV7addressSSvp":{"name":"address","abstract":"

The KT address of the exchange contract

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV7tezPoolSSvp":{"name":"tezPool","abstract":"

String representation of the Exchanges TezPool

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV9tokenPoolSSvp":{"name":"tokenPool","abstract":"

String representation of the Exchanges TokenPool

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV11sharesTotalSSvp":{"name":"sharesTotal","abstract":"

The total liquidity available (RPC representation, no decimals)

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV8midPriceSSvp":{"name":"midPrice","abstract":"

The daily middle price

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV5tokenAA0dE5TokenVvp":{"name":"token","abstract":"

The token object containing all the token info (decimals, contract address, symbol etc,)

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV13xtzPoolAmountAA9XTZAmountCyF":{"name":"xtzPoolAmount()","abstract":"

Return the XTZ pool as an XTZAmount object

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV15tokenPoolAmountAA05TokenI0CyF":{"name":"tokenPoolAmount()","abstract":"

Return the Token pool as an TokenAmount object

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV27liquidityTokenDecimalPlacesSiyF":{"name":"liquidityTokenDecimalPlaces()","abstract":"

Retrieving the liquidity token decimals is currently not supported. Hardcode the numbers for now

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV14totalLiquidityAA11TokenAmountCyF":{"name":"totalLiquidity()","abstract":"

Return the total liquidity as an TokenAmount object

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV13arePoolsEmptySbyF":{"name":"arePoolsEmpty()","abstract":"

Helper to detect if the pools are empty (determiens if the next addLiquidity will be setting the exchange rate)

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupExchange"},"Structs/DipDupExchange.html#/s:14KukaiCoreSwift14DipDupExchangeV2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable to enable working with UITableViewDiffableDataSource

","parent_name":"DipDupExchange"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV6symbolSSvp":{"name":"symbol","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV7addressSSvp":{"name":"address","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV7tokenIdSo9NSDecimalavp":{"name":"tokenId","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV9exchangesSayAA0dE8ExchangeVGvp":{"name":"exchanges","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokens.html#/s:14KukaiCoreSwift24DipDupExchangesAndTokensV20totalExchangeXtzPoolAA9XTZAmountCyF":{"name":"totalExchangeXtzPool()","abstract":"

Get the total XTZ pool amount from all the exchanges, useful for sorting

","parent_name":"DipDupExchangesAndTokens"},"Structs/DipDupExchangesAndTokensResponse.html#/s:14KukaiCoreSwift32DipDupExchangesAndTokensResponseV5tokenSayAA0defgH0VGvp":{"name":"token","parent_name":"DipDupExchangesAndTokensResponse"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV7averageSo9NSDecimalavp":{"name":"average","abstract":"

The average price at the given time

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV10exchangeIdSSvp":{"name":"exchangeId","abstract":"

The address of the contract

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV6bucketSSvp":{"name":"bucket","abstract":"

String representing the date and time the slice is for

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV4highSSvp":{"name":"high","abstract":"

The highest value reached in this slice

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV3lowSSvp":{"name":"low","abstract":"

The lowest value reached in this slice

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV4date10Foundation4DateVSgyF":{"name":"date()","abstract":"

Convert the bucket string into a Date object

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV13averageDoubleSdyF":{"name":"averageDouble()","abstract":"

Convert the average value into a Double

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV10highDoubleSdyF":{"name":"highDouble()","abstract":"

Convert the high value into a Double

","parent_name":"DipDupChartObject"},"Structs/DipDupChartObject.html#/s:14KukaiCoreSwift17DipDupChartObjectV9lowDoubleSdyF":{"name":"lowDouble()","abstract":"

Convert the low value into a Double

","parent_name":"DipDupChartObject"},"Structs/DipDupChartData.html#/s:14KukaiCoreSwift15DipDupChartDataV15quotes15mNogapsSayAA0deF6ObjectVGvp":{"name":"quotes15mNogaps","abstract":"

Contains the last 24 hours of data at 15 min intervals

","parent_name":"DipDupChartData"},"Structs/DipDupChartData.html#/s:14KukaiCoreSwift15DipDupChartDataV14quotes1hNogapsSayAA0deF6ObjectVGvp":{"name":"quotes1hNogaps","abstract":"

Contains every hour for past 7 days

","parent_name":"DipDupChartData"},"Structs/DipDupChartData.html#/s:14KukaiCoreSwift15DipDupChartDataV14quotes1dNogapsSayAA0deF6ObjectVGvp":{"name":"quotes1dNogaps","abstract":"

Contains every day for 30 days

","parent_name":"DipDupChartData"},"Structs/DipDupChartData.html#/s:14KukaiCoreSwift15DipDupChartDataV14quotes1wNogapsSayAA0deF6ObjectVGvp":{"name":"quotes1wNogaps","abstract":"

Contains every week for 52 weeks

","parent_name":"DipDupChartData"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV2idSSvp":{"name":"id","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV5titleSSvp":{"name":"title","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV5descrSSvp":{"name":"descr","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV4kindSSvp":{"name":"kind","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV8locationSiSgvp":{"name":"location","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperationError.html#/s:14KukaiCoreSwift27BetterCallDevOperationErrorV4withSSSgvp":{"name":"with","parent_name":"BetterCallDevOperationError"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV2idSivp":{"name":"id","abstract":"

An ID used by BCD

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV4hashSSvp":{"name":"hash","abstract":"

The operation hash

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV7counterSivp":{"name":"counter","abstract":"

The operations numeric counter

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV6statusSSvp":{"name":"status","abstract":"

Indicating if the operation was successful, failed, backtracked etc.

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV6errorsSayAA0defG5ErrorVGSgvp":{"name":"errors","abstract":"

Detailed error objects, also including unique smart contract errors

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV8isFailedSbyF":{"name":"isFailed()","abstract":"

Helper to determine if the operation failed or not

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV13containsErrorSbyF":{"name":"containsError()","abstract":"

Helper to check for existance of errors

","parent_name":"BetterCallDevOperation"},"Structs/BetterCallDevOperation.html#/s:14KukaiCoreSwift22BetterCallDevOperationV17moreDetailedErrorAA0defgJ0VSgyF":{"name":"moreDetailedError()","abstract":"

When looking for more detailed errors through Better-Call.dev, effectively we are looking for an error containing a location and/or a with.","parent_name":"BetterCallDevOperation"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV10bakerAliasSSSgvp":{"name":"bakerAlias","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV9bakerLogo10Foundation3URLVSgvp":{"name":"bakerLogo","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV14paymentAddressSSvp":{"name":"paymentAddress","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV6amountAA9XTZAmountCvp":{"name":"amount","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV5cycleSivp":{"name":"cycle","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV3feeSdvp":{"name":"fee","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV13dateOfPayment10Foundation4DateVvp":{"name":"dateOfPayment","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV18meetsMinDelegationSbvp":{"name":"meetsMinDelegation","parent_name":"RewardDetails"},"Structs/RewardDetails.html#/s:14KukaiCoreSwift13RewardDetailsV10bakerAlias0F4Logo14paymentAddress6amount5cycle3fee4date18meetsMinDelegationACSSSg_10Foundation3URLVSgSSAA9XTZAmountCSiSdAM4DateVSbtcfc":{"name":"init(bakerAlias:bakerLogo:paymentAddress:amount:cycle:fee:date:meetsMinDelegation:)","parent_name":"RewardDetails"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV08previousE0AA0E7DetailsVSgvp":{"name":"previousReward","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV017estimatedPreviousE0AA0E7DetailsVSgvp":{"name":"estimatedPreviousReward","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV013estimatedNextE0AA0E7DetailsVSgvp":{"name":"estimatedNextReward","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV08previousE0017estimatedPreviousE00h4NextE0AcA0E7DetailsVSg_A2Itcfc":{"name":"init(previousReward:estimatedPreviousReward:estimatedNextReward:)","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV11isOutOfDateSbyF":{"name":"isOutOfDate()","abstract":"

Creating this object involves many expensive requests, but produces a result that is valid for up to ~3 days.","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:14KukaiCoreSwift26AggregateRewardInformationV35moreThan1CycleBetweenPreiousAndNextSbyF":{"name":"moreThan1CycleBetweenPreiousAndNext()","abstract":"

When previousReward is present, it is possible that due to a delay in payment being received, that we may cache an object before the last payment was received","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"AggregateRewardInformation"},"Structs/AggregateRewardInformation.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"AggregateRewardInformation"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV13walletAddressSSvp":{"name":"walletAddress","abstract":"

The wallet address

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV10xtzBalanceAA9XTZAmountCvp":{"name":"xtzBalance","abstract":"

The XTZ balance of the wallet

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV6tokensSayAA5TokenCGvp":{"name":"tokens","abstract":"

All the wallets FA1.2, FA2 funginble tokens

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV4nftsSayAA5TokenCGvp":{"name":"nfts","abstract":"

All the wallets NFT’s, grouped into parent FA2 objects so they can be displayed in groups or individaully

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV10recentNFTsSayAA3NFTVGvp":{"name":"recentNFTs","abstract":"

10 most recent NFTs to hit the wallet

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV15liquidityTokensSayAA18DipDupPositionDataVGvp":{"name":"liquidityTokens","abstract":"

All the wallets Defi, Liquidity Tokens

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV8delegateAA19TzKTAccountDelegateVSgvp":{"name":"delegate","abstract":"

TzKT object containing baker details + status

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV15delegationLevelSo9NSDecimalaSgvp":{"name":"delegationLevel","abstract":"

The block level that the delegate was set

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV13walletAddressACSS_tcfc":{"name":"init(walletAddress:)","abstract":"

Basic init to default properties to zero / empty, so that optionals can be avoided on a key model throughout an app

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV13walletAddress10xtzBalance6tokens4nfts10recentNFTs15liquidityTokens8delegate15delegationLevelACSS_AA9XTZAmountCSayAA5TokenCGAPSayAA3NFTVGSayAA18DipDupPositionDataVGAA19TzKTAccountDelegateVSgSo9NSDecimalaSgtcfc":{"name":"init(walletAddress:xtzBalance:tokens:nfts:recentNFTs:liquidityTokens:delegate:delegationLevel:)","abstract":"

Full init

","parent_name":"Account"},"Structs/Account.html#/s:14KukaiCoreSwift7AccountV4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"Account"},"Structs/Account.html#/s:s12IdentifiableP2id2IDQzvp":{"name":"id","parent_name":"Account"},"Structs/Account.html":{"name":"Account","abstract":"

Fetching all the account balances is a lengthy task, involving many requests and parsing different structures."},"Structs/AggregateRewardInformation.html":{"name":"AggregateRewardInformation","abstract":"

Object ot abstract away a significatn amount of logic involved in computing estimated reward payments from a baker

"},"Structs/RewardDetails.html":{"name":"RewardDetails","abstract":"

An individual payment record denoting some payment in the past or future

"},"Structs/BetterCallDevOperation.html":{"name":"BetterCallDevOperation","abstract":"

A model matching the response that comes back from BetterCallDev’s API: v1/opg/<operation-hash>

"},"Structs/BetterCallDevOperationError.html":{"name":"BetterCallDevOperationError","abstract":"

BetterCallDev structure for errors

"},"Structs/DipDupChartData.html":{"name":"DipDupChartData","abstract":"

Struct to hold 4 arrays of data, each one mapping to a different timeline of data, to allow the display of graphs

"},"Structs/DipDupChartObject.html":{"name":"DipDupChartObject","abstract":"

Structure holding a data slice

"},"Structs/DipDupExchangesAndTokensResponse.html":{"name":"DipDupExchangesAndTokensResponse","abstract":"

Wrapper object to map to network response type

"},"Structs/DipDupExchangesAndTokens.html":{"name":"DipDupExchangesAndTokens","abstract":"

Wrapper object to map to network response type

"},"Structs/DipDupExchange.html":{"name":"DipDupExchange","abstract":"

A DipDup Exchange object with all the necessary pieces for checking liquidity and performing Swaps

"},"Structs/DipDupPosition.html":{"name":"DipDupPosition","abstract":"

Wrapper object to match network response type

"},"Structs/DipDupPositionData.html":{"name":"DipDupPositionData","abstract":"

A position on DipDup corresponds to liquidity token ownership. Each of these objects represents an amount of Liquidity tokens in an exchange for the given address

"},"Structs/DipDupToken.html":{"name":"DipDupToken","abstract":"

DipDup representation of a Token

"},"Structs/TzKTAccount.html":{"name":"TzKTAccount","abstract":"

Model mapping to TzKT.io’s Account object

"},"Structs/TzKTAccountDelegate.html":{"name":"TzKTAccountDelegate","abstract":"

Model mapping to TzKT.io’s Account.Delegate Object

"},"Structs/TzKTAddress.html":{"name":"TzKTAddress","abstract":"

Details about a given contract

"},"Structs/TzKTBaker.html":{"name":"TzKTBaker","abstract":"

Data representing a baker from TzKT or Baking-Bad

"},"Structs/TzKTBakerConfig.html":{"name":"TzKTBakerConfig","abstract":"

The bakers config file for details on when fees, min delegation etc change

"},"Structs/TzKTBakerConfigDoubleValue.html":{"name":"TzKTBakerConfigDoubleValue"},"Structs/TzKTBakerConfigIntValue.html":{"name":"TzKTBakerConfigIntValue"},"Structs/TzKTBakerConfigRewardStruct.html":{"name":"TzKTBakerConfigRewardStruct","abstract":"

Baker config payout flags

"},"Structs/TzKTBalance.html":{"name":"TzKTBalance","abstract":"

Model mapping to the Balance object returned from the new TzKT API, resulting from the merge of BCD and TzKT

"},"Structs/TzKTBalanceToken.html":{"name":"TzKTBalanceToken","abstract":"

Model encapsulating information about the token itself

"},"Structs/TzKTBalanceMetadata.html":{"name":"TzKTBalanceMetadata","abstract":"

Metadata object for the token

"},"Structs/TzKTBalanceMetadataAttributeKeyValue.html":{"name":"TzKTBalanceMetadataAttributeKeyValue","abstract":"

Wrapper / Helper to extract metadata attribute content

"},"Structs/TzKTBalanceMetadataFormat.html":{"name":"TzKTBalanceMetadataFormat","abstract":"

Object containing information about the various formats the media is available in

"},"Structs/TzKTBalanceMetadataDimensions.html":{"name":"TzKTBalanceMetadataDimensions","abstract":"

Object containing information about the dimensions of a given piece of media

"},"Structs/TzKTCycle.html":{"name":"TzKTCycle","abstract":"

The blockchain is broken down into cycles that last 2.7 days. Baker payment logic resolves around cycles instead of blocks

"},"Structs/TzKTDelegatorReward.html":{"name":"TzKTDelegatorReward","abstract":"

An object containing info on the reward a delegator should receive from a baker

"},"Structs/TzKTOperation.html":{"name":"TzKTOperation","abstract":"

A model matching the response that comes back from TzKT’s API: v1/operations/<operation-hash>

"},"Structs/TzKTOperationError.html":{"name":"TzKTOperationError","abstract":"

TzKT’s more basic error object response

"},"Structs/TzKTTokenTransfer.html":{"name":"TzKTTokenTransfer","abstract":"

FA1.2 / FA2 token transafers are treated differently from transactions. This object is used when fetching data form the API, as a temporary placeholder, ultimately to be merged into the transactions

"},"Structs/TzKTTransaction.html":{"name":"TzKTTransaction","abstract":"

A model matching the response that comes back from TzKT’s API: v1/accounts/<address>/operations

"},"Structs/TzKTTransactionGroup.html":{"name":"TzKTTransactionGroup","abstract":"

Artifical object used to group related transactions into a more user friendly display"},"Structs/BlockchainHead.html":{"name":"BlockchainHead","abstract":"

Structure representing the HEAD of the blockchain

"},"Structs/LoggingConfig.html":{"name":"LoggingConfig","abstract":"

A struct to control what messages get logged

"},"Structs/TezosNodeClientConfig.html":{"name":"TezosNodeClientConfig","abstract":"

A configuration object used to provide settings to the TezosNodeClient

"},"Structs/QuipuswapExchangeLedgerKey.html":{"name":"QuipuswapExchangeLedgerKey","abstract":"

The gneric container object holding the raw data

"},"Structs/QuipuswapExchangeLedger.html":{"name":"QuipuswapExchangeLedger","abstract":"

The unique data inside the Ledger BigMap

"},"Structs/QuipuswapExchangeStorageResponse.html":{"name":"QuipuswapExchangeStorageResponse","abstract":"

Network wrapper object

"},"Structs/QuipuswapExchangeStorage.html":{"name":"QuipuswapExchangeStorage","abstract":"

Unique Quipuswap contract storage object

"},"Structs/QuipuswapExchangeUserRewardsKey.html":{"name":"QuipuswapExchangeUserRewardsKey","abstract":"

The gneric container object holding the raw data

"},"Structs/QuipuswapExchangeUserRewards.html":{"name":"QuipuswapExchangeUserRewards","abstract":"

The unique data inside the User Rewards BigMap

"},"Structs/FailWithParserLiquidityBaking.html":{"name":"FailWithParserLiquidityBaking","abstract":"

Dedicated “FailWith” parser for the codes received from Liquidity Baking contract

"},"Structs/GraphQLError.html":{"name":"GraphQLError","abstract":"

GraphQL error object

"},"Structs/GraphQLResponse.html":{"name":"GraphQLResponse","abstract":"

Simple model object to wrap a GraphQL response to expose a Codable response without having to use large GraphQL libraries

"},"Structs/ObjktCollections.html":{"name":"ObjktCollections","abstract":"

GarpQL bulk response for a group of collections

"},"Structs/ObjktCollection.html":{"name":"ObjktCollection","abstract":"

Single collection item

"},"Structs/ObjktCreator.html":{"name":"ObjktCreator"},"Structs/ObjktTokenReponse.html":{"name":"ObjktTokenReponse","abstract":"

GarpQL response for required data for a given token

"},"Structs/ObjktToken.html":{"name":"ObjktToken","abstract":"

Single token item

"},"Structs/ObjktAttribute.html":{"name":"ObjktAttribute"},"Structs/ObjktAttributeData.html":{"name":"ObjktAttributeData"},"Structs/ObjktAttributeCounts.html":{"name":"ObjktAttributeCounts"},"Structs/ObjktSale.html":{"name":"ObjktSale"},"Structs/ObjktListing.html":{"name":"ObjktListing"},"Structs/ObjktEvent.html":{"name":"ObjktEvent","abstract":"

Single event item

"},"Structs/ObjktFa.html":{"name":"ObjktFa","abstract":"

Single FA item

"},"Structs/TezosDomainsAddressBulkResponse.html":{"name":"TezosDomainsAddressBulkResponse","abstract":"

Response object wrapper for querying an address in bulk

"},"Structs/TezosDomainsDomains.html":{"name":"TezosDomainsDomains","abstract":"

Object containing an array of domains

"},"Structs/TezosDomainsAddressResponse.html":{"name":"TezosDomainsAddressResponse","abstract":"

Response object wrapper for querying an address

"},"Structs/TezosDomainsDomain.html":{"name":"TezosDomainsDomain","abstract":"

Domain object containing details about the domain

"},"Structs/TezosDomainsDomainResponse.html":{"name":"TezosDomainsDomainResponse","abstract":"

Response object wrapper for querying a reverse record

"},"Structs/TezosDomainsDomainBulkResponse.html":{"name":"TezosDomainsDomainBulkResponse","abstract":"

Response object wrapper for querying a reverse record in bulk

"},"Structs/TezosDomainsReverseRecords.html":{"name":"TezosDomainsReverseRecords","abstract":"

Object containing an array of reverse records

"},"Structs/TezosDomainsReverseRecord.html":{"name":"TezosDomainsReverseRecord","abstract":"

Object containing all the info of the tezos domains record

"},"Structs/LiquidityBakingData.html":{"name":"LiquidityBakingData","abstract":"

Wrapper object to hold onto all the necessary data in order to work with liquidity baking contract (swap, add or remove liqudity)

"},"Structs/NFT.html":{"name":"NFT","abstract":"

An indiviual NFT (not the parent token/collection) holding a URI to an asset somewhere on the internet

"},"Structs/NetworkConstants.html":{"name":"NetworkConstants","abstract":"

The contants that a given Tezos node is using for block times, blakc size etc

"},"Structs/NetworkVersion.html":{"name":"NetworkVersion","abstract":"

The version of the Tezos code being run by the given node

"},"Structs/NilOnDecodingError.html":{"name":"NilOnDecodingError","abstract":"

property wrapper to easily handle a situation where we don’t want decoding to fail for 1 property which may be problematic. Instead just default it to nil

"},"Structs/OperationBlockHeader.html":{"name":"OperationBlockHeader"},"Structs/OperationFees.html":{"name":"OperationFees","abstract":"

A structure representing all the fees, storage and computation needed to perform an Operation

"},"Structs/OperationMetadata.html":{"name":"OperationMetadata","abstract":"

Structure representing the metadata needed by Operation‘s in order to comply with the RPC standards

"},"Structs/OperationPayload.html":{"name":"OperationPayload","abstract":"

A structure representing the request that needs to be made when sending Opertion‘s to the RPC

"},"Structs/OperationResponse.html":{"name":"OperationResponse","abstract":"

Structure representing the response returned from RPC endpoints such as .../preapply/operations

"},"Structs.html#/s:14KukaiCoreSwift24OperationResponseContentV":{"name":"OperationResponseContent","abstract":"

The main content of the JSON returned

"},"Structs.html#/s:14KukaiCoreSwift25OperationResponseMetadataV":{"name":"OperationResponseMetadata","abstract":"

The metadata belonging to the OperationResponse

"},"Structs.html#/s:14KukaiCoreSwift13BalanceUpdateV":{"name":"BalanceUpdate","abstract":"

Struct representing a change to the balance of the sender, destination or intermediary contract

"},"Structs.html#/s:14KukaiCoreSwift23OperationResponseResultV":{"name":"OperationResponseResult","abstract":"

The inner result key from the OeprationResponse

"},"Structs.html#/s:14KukaiCoreSwift025OperationResponseInternalD0V":{"name":"OperationResponseInternalOperation","abstract":"

Definition of the internal operation found inside OperationResponse

"},"Structs/OperationResponseInternalResultError.html":{"name":"OperationResponseInternalResultError","abstract":"

Definition of the outer Error object found inside OperationResponseInternalResult

"},"Structs/FailWith.html":{"name":"FailWith","abstract":"

The error string, error int (code), or micheline error object returned inside FailWith

"},"Structs.html#/s:14KukaiCoreSwift19RunOperationPayloadV":{"name":"RunOperationPayload","abstract":"

Payload object needed when sending operations to …/run_operation

"},"Structs/SVGImgProcessor.html":{"name":"SVGImgProcessor","abstract":"

SVG image processor for Kingfisher library

"},"Structs.html#/s:14KukaiCoreSwift21OperationSubscriptionV":{"name":"OperationSubscription","abstract":"

Object for sending a request through SignalR to listen to operations for a given account

"},"Structs/WalletMetadataList.html":{"name":"WalletMetadataList","abstract":"

Container to store groups of WalletMetadata based on type

"},"Structs/WalletMetadata.html":{"name":"WalletMetadata","abstract":"

Object to store UI related info about wallets, seperated from the wallet object itself to avoid issues merging together

"},"Structs/DexSwapCalculationResult.html":{"name":"DexSwapCalculationResult","abstract":"

A struct to hold all the necessary calculations for a dex trade

"},"Structs/DexAddCalculationResult.html":{"name":"DexAddCalculationResult","abstract":"

A struct to hold all the necessary calculations for adding liquidity to a dex contract

"},"Structs/DexRemoveCalculationResult.html":{"name":"DexRemoveCalculationResult","abstract":"

A struct to hold all the necessary calculations for removing liquidity from a dex contract

"},"Structs/KukaiError.html":{"name":"KukaiError","abstract":"

A struct conforming to Error, attempting to handle errors from all sources (RPC, network, OS, other services/components/libraries), without the implementing code having to deal with each layer themselves."},"Structs.html#/s:14KukaiCoreSwift4DAppV":{"name":"DApp"},"Structs.html#/s:14KukaiCoreSwift16OfflineConstantsV":{"name":"OfflineConstants"},"Structs/SubverifierWrapper.html":{"name":"SubverifierWrapper","abstract":"

SDK requires information about the verifer that can’t be stored inside the verifier, add a wrapper object to allow passing of all the data

"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP4typeAA0D4TypeOvp":{"name":"type","abstract":"

Which underlying WalletType is the wallet using

","parent_name":"Wallet"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP7addressSSvp":{"name":"address","abstract":"

The public TZ1 or TZ2 address of the wallet

","parent_name":"Wallet"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP4sign_11isOperation10completionySS_Sbys6ResultOySays5UInt8VGAA0A5ErrorVGctF":{"name":"sign(_:isOperation:completion:)","abstract":"

Sign a hex string with the wallets private key

","parent_name":"Wallet"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP15privateKeyCurve0a6CryptoC0010EllipticalG0OyF":{"name":"privateKeyCurve()","abstract":"

Query which curve the given wallet is using

","parent_name":"Wallet"},"Protocols/Wallet.html#/s:14KukaiCoreSwift6WalletP22publicKeyBase58encodedSSyF":{"name":"publicKeyBase58encoded()","abstract":"

Base58 encoded version of the publicKey, used when performing a reveal operation

","parent_name":"Wallet"},"Protocols/FailWithParser.html#/s:14KukaiCoreSwift14FailWithParserP5parse04failE0SSSgAA0dE0VSg_tF":{"name":"parse(failWith:)","abstract":"

Take in a failWith and return a message

","parent_name":"FailWithParser"},"Protocols/FailWithParser.html":{"name":"FailWithParser","abstract":"

Protocol to allow defining multiple dedicated structs, one for each dApp, that knows how to convert the specific failWith cases into more human readable error messages

"},"Protocols/Wallet.html":{"name":"Wallet","abstract":"

Wallet protocol to allow generic handling of all wallets types for signing operations and caching data locally.

"},"Extensions/KeyedDecodingContainer.html#/s:s22KeyedDecodingContainerV14KukaiCoreSwiftE6decode_6forKeyAC05NilOnB5ErrorVyqd__GAHm_xtKSeRd__lF":{"name":"decode(_:forKey:)","parent_name":"KeyedDecodingContainer"},"Extensions/KeyedDecodingContainer.html#/s:s22KeyedDecodingContainerV14KukaiCoreSwiftE15decodeIfPresent_6forKey08orBackupK0qd__Sgqd__m_xxtKSeRd__lF":{"name":"decodeIfPresent(_:forKey:orBackupKey:)","abstract":"

In case where people have not followed the spec correctly, and named keys slightly differently, allow a second key to be used so that, for example, we could check for artifcatUri or artifact_uri in one call

","parent_name":"KeyedDecodingContainer"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftSDySSypGRszlE12michelsonInt7atIndexSSSgSi_tF":{"name":"michelsonInt(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftSDySSypGRszlE15michelsonString7atIndexSSSgSi_tF":{"name":"michelsonString(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftSDySSypGRszlE13michelsonPair7atIndexABSgSi_tF":{"name":"michelsonPair(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftypRszlE12michelsonInt7atIndexSSSgSi_tF":{"name":"michelsonInt(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftypRszlE15michelsonString7atIndexSSSgSi_tF":{"name":"michelsonString(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftypRszlE13michelsonPair7atIndexSDySSypGSgSi_tF":{"name":"michelsonPair(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftypRszlE14michelsonArray7atIndexSayypGSgSi_tF":{"name":"michelsonArray(atIndex:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa14KukaiCoreSwiftAA9OperationCRszlE14copyOperationsSayACGyF":{"name":"copyOperations()","abstract":"

Operation’s are classes, passed by reference, but often require making copies so that you can manipulate them before sending to be estimated.","parent_name":"Array"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE14michelsonValueSDySSypGSgyF":{"name":"michelsonValue()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE19michelsonValueArraySaySDySSypGGSgyF":{"name":"michelsonValueArray()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE18michelsonArgsArraySaySDySSypGGSgyF":{"name":"michelsonArgsArray()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE25michelsonArgsUnknownArraySayypGSgyF":{"name":"michelsonArgsUnknownArray()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE12michelsonIntSSSgyF":{"name":"michelsonInt()","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD14KukaiCoreSwiftSSRszrlE15michelsonStringSSSgyF":{"name":"michelsonString()","parent_name":"Dictionary"},"Extensions/NSImage.html#/cgImage":{"name":"cgImage","parent_name":"NSImage"},"Extensions/NSImage.html#/init(named:)":{"name":"init(named:)","parent_name":"NSImage"},"Extensions/Thread.html#/s:So8NSThreadC14KukaiCoreSwiftE15isRunningXCTestSbvp":{"name":"isRunningXCTest","abstract":"

Check if the given thread is being run from inside an XCTest bundle

","parent_name":"Thread"},"Extensions/String.html#/s:SS14KukaiCoreSwiftE9indexesOf6stringSaySS5IndexVGSS_tF":{"name":"indexesOf(string:)","abstract":"

Return the starting indexes of each occurnace of the supplied string

","parent_name":"String"},"Extensions/String.html#/s:SS14KukaiCoreSwiftE33removeLeadingProtocolFromRPCErrorSSSgyF":{"name":"removeLeadingProtocolFromRPCError()","abstract":"

When an error is returned in the format proto.012-Psithaca.gas_exhausted.operation, in many cases we only care about the bit after the protocol. This function returns only that piece

","parent_name":"String"},"Extensions/Result.html#/s:s6ResultO14KukaiCoreSwiftE8getErrorq_yKF":{"name":"getError()","abstract":"

Similar to Result.get(), getError returns the failure case or throws

","parent_name":"Result"},"Extensions/Result.html#/s:s6ResultO14KukaiCoreSwiftAC0B5ErrorVRs_rlE10getFailureAEyF":{"name":"getFailure()","abstract":"

Similar to Result.get(), getFailure returns the kukai-core-specific KukaiError case or throws

","parent_name":"Result"},"Extensions/AnyPublisher.html#/s:7Combine12AnyPublisherV14KukaiCoreSwiftE4justyACyxq_GxFZ":{"name":"just(_:)","abstract":"

Helper for returning a Just publisher, with the appropriate Failure type and erased to AnyPublisher

","parent_name":"AnyPublisher"},"Extensions/AnyPublisher.html#/s:7Combine12AnyPublisherV14KukaiCoreSwiftE4fail4withACyxq_Gq__tFZ":{"name":"fail(with:)","abstract":"

Helper for returning a Fail publisher, erased to AnyPublisher

","parent_name":"AnyPublisher"},"Extensions/AnyPublisher.html#/s:7Combine12AnyPublisherV14KukaiCoreSwiftE15onReceiveOutputyAA10PublishersO12HandleEventsVy_ACyxq_GGyxcF":{"name":"onReceiveOutput(_:)","abstract":"

Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

","parent_name":"AnyPublisher"},"Extensions/AnyPublisher.html#/s:7Combine12AnyPublisherV14KukaiCoreSwiftE4sink7onError0H7Success0H8CompleteAA0B11CancellableCyq_c_yxcyycSgtF":{"name":"sink(onError:onSuccess:onComplete:)","abstract":"

Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

","parent_name":"AnyPublisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE8asFutureAA0G0Cy6OutputQzs5NeverOGyF":{"name":"asFuture()","abstract":"

Wrap a Publisher in a Future of type <Output, Never>

","parent_name":"Publisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE16asDeferredFutureAA0G0VyAA0H0Cy6OutputQzs5NeverOGGyF":{"name":"asDeferredFuture()","abstract":"

Wrap a Publisher in a Deferred Future of type <Output, Never>

","parent_name":"Publisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE15convertToResultAA03AnyB0Vys0H0Oy6OutputQz7FailureQzGs5NeverOGyF":{"name":"convertToResult()","abstract":"

Convert a publisher output into a swift Resultobject to make handling sink‘s easier

","parent_name":"Publisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE15onReceiveOutputyAA10PublishersO12HandleEventsVy_xGy0H0QzcF":{"name":"onReceiveOutput(_:)","abstract":"

Call .handleEvents, but only use the receiveOutput callback as a shorthand way of running some logic or clean up code

","parent_name":"Publisher"},"Extensions/Publisher.html#/s:7Combine9PublisherP14KukaiCoreSwiftE4sink7onError0G7Success0G8CompleteAA14AnyCancellableCy7FailureQzc_y6OutputQzcyycSgtF":{"name":"sink(onError:onSuccess:onComplete:)","abstract":"

Custom sink implementation breaking each piece into a seperate dedicated callback, avoiding the need to call a switch or unwrap an error

","parent_name":"Publisher"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE05kukaidE0ACvpZ":{"name":"kukaiCoreSwift","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE11walletCacheACvpZ":{"name":"walletCache","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE05kukaidE5ErrorACvpZ":{"name":"kukaiCoreSwiftError","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE8keychainACvpZ":{"name":"keychain","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE7networkACvpZ":{"name":"network","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE3bcdACvpZ":{"name":"bcd","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE4tzktACvpZ":{"name":"tzkt","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE14taquitoServiceACvpZ":{"name":"taquitoService","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE5torusACvpZ":{"name":"torus","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE6ledgerACvpZ":{"name":"ledger","parent_name":"Logger"},"Extensions/Logger.html#/s:2os6LoggerV14KukaiCoreSwiftE3appACvpZ":{"name":"app","abstract":"

Used by the app importing this library

","parent_name":"Logger"},"Extensions/Error.html#/s:s5ErrorP14KukaiCoreSwiftE4codeSivp":{"name":"code","abstract":"

Access NSError.code

","parent_name":"Error"},"Extensions/Error.html#/s:s5ErrorP14KukaiCoreSwiftE6domainSSvp":{"name":"domain","abstract":"

Access NSError.domain

","parent_name":"Error"},"Extensions/Error.html#/s:s5ErrorP14KukaiCoreSwiftE8userInfoSDySSypGvp":{"name":"userInfo","abstract":"

Access NSError.userInfo

","parent_name":"Error"},"Extensions/Error.html#/s:s5ErrorP14KukaiCoreSwiftE010underlyingA0So7NSErrorCSgvp":{"name":"underlyingError","abstract":"

Access NSError.userInfo[NSUnderlyingErrorKey] and cast to swift Error

","parent_name":"Error"},"Extensions/Decimal.html#/s:So9NSDecimala14KukaiCoreSwiftE7rounded5scale12roundingModeABSi_So010NSRoundingH0VtF":{"name":"rounded(scale:roundingMode:)","abstract":"

Wrapper around the Objective-c code needed to round a Decimal

","parent_name":"Decimal"},"Extensions/Decimal.html#/s:So9NSDecimala14KukaiCoreSwiftE8intValueSiyF":{"name":"intValue()","abstract":"

Wrapper around the Objective-c code needed to return an Int from a decimal

","parent_name":"Decimal"},"Extensions/DateFormatter.html#/s:So15NSDateFormatterC14KukaiCoreSwiftE10withFormatABSS_tcfc":{"name":"init(withFormat:)","abstract":"

Helper to create a DateFormatter with a format in 1 call

","parent_name":"DateFormatter"},"Extensions/Date.html#/s:10Foundation4DateV14KukaiCoreSwiftE14timeAgoDisplaySSyF":{"name":"timeAgoDisplay()","abstract":"

Helper to return strings like “15 seconds ago”, “1 minute ago” etc, from a Date

","parent_name":"Date"},"Extensions/Collection.html#/s:Sl14KukaiCoreSwiftE4safe7ElementQzSg5IndexQz_tcip":{"name":"subscript(safe:)","abstract":"

Returns the element at the specified index if it is within bounds, otherwise nil.

","parent_name":"Collection"},"Extensions/Collection.html#/s:Sl14KukaiCoreSwift7Combine9Publisher7ElementRpzrlE21concatenatePublishersAB03AnyE0VyAD_6OutputQZAD_7FailureQZGSgyF":{"name":"concatenatePublishers()","abstract":"

Convert an array of publishers into a concatenation, so that they will all run sequentually. Code from: https://www.apeth.com/UnderstandingCombine/operators/operatorsJoiners/operatorsappend.html

","parent_name":"Collection"},"Extensions/Collection.html":{"name":"Collection"},"Extensions/Date.html":{"name":"Date"},"Extensions/DateFormatter.html":{"name":"DateFormatter"},"Extensions/Decimal.html":{"name":"Decimal"},"Extensions/Error.html":{"name":"Error","abstract":"

Exposing underlying NSError properties not accessible to Swift Error without casting

"},"Extensions/Logger.html":{"name":"Logger","abstract":"

Extension to OSLog to create some custom categories for logging

"},"Extensions/Publisher.html":{"name":"Publisher"},"Extensions/AnyPublisher.html":{"name":"AnyPublisher"},"Extensions/Result.html":{"name":"Result"},"Extensions/String.html":{"name":"String"},"Extensions/Thread.html":{"name":"Thread"},"Extensions/NSImage.html":{"name":"NSImage","abstract":"

Create standard UIImage properties and methods

"},"Extensions.html#/s:14KukaiCoreSwift16LossyCodableListV":{"name":"LossyCodableList"},"Extensions/Dictionary.html":{"name":"Dictionary","abstract":"

Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

"},"Extensions/Array.html":{"name":"Array","abstract":"

Helper methods for extracting data from Michelson JSON, to reduce the amount of as? [String: Any] extracting, and instead use some of the standarad naming

"},"Extensions/KeyedDecodingContainer.html":{"name":"KeyedDecodingContainer"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO15missingVerifieryA2CmF":{"name":"missingVerifier","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO07invalidD8ResponseyA2CmF":{"name":"invalidTorusResponse","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO06cryptoF0yA2CmF":{"name":"cryptoError","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO18invalidNodeDetailsyA2CmF":{"name":"invalidNodeDetails","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO17invalidTwitterURLyA2CmF":{"name":"invalidTwitterURL","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO20noTwiiterUserIdFoundyA2CmF":{"name":"noTwiiterUserIdFound","parent_name":"TorusAuthError"},"Enums/TorusAuthError.html#/s:14KukaiCoreSwift14TorusAuthErrorO20invalidAppleResponseyA2CmF":{"name":"invalidAppleResponse","parent_name":"TorusAuthError"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO5appleyA2CmF":{"name":"apple","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO6googleyA2CmF":{"name":"google","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO8facebookyA2CmF":{"name":"facebook","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO7twitteryA2CmF":{"name":"twitter","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO6reddityA2CmF":{"name":"reddit","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO7discordyA2CmF":{"name":"discord","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO6twitchyA2CmF":{"name":"twitch","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO4lineyA2CmF":{"name":"line","parent_name":"TorusAuthProvider"},"Enums/TorusAuthProvider.html#/s:14KukaiCoreSwift17TorusAuthProviderO6githubyA2CmF":{"name":"github","parent_name":"TorusAuthProvider"},"Enums/DAppAccessType.html#/s:14KukaiCoreSwift14DAppAccessTypeO3allyA2CmF":{"name":"all","parent_name":"DAppAccessType"},"Enums/DAppAccessType.html#/s:14KukaiCoreSwift14DAppAccessTypeO14directAuthOnlyyA2CmF":{"name":"directAuthOnly","parent_name":"DAppAccessType"},"Enums/DAppAccessType.html#/s:14KukaiCoreSwift14DAppAccessTypeO4noneyA2CmF":{"name":"none","parent_name":"DAppAccessType"},"Enums/DAppCategory.html#/s:14KukaiCoreSwift12DAppCategoryO11marketplaceyA2CmF":{"name":"marketplace","parent_name":"DAppCategory"},"Enums/DAppCategory.html#/s:14KukaiCoreSwift12DAppCategoryO8exchangeyA2CmF":{"name":"exchange","parent_name":"DAppCategory"},"Enums/DAppCategory.html#/s:14KukaiCoreSwift12DAppCategoryO11collectibleyA2CmF":{"name":"collectible","parent_name":"DAppCategory"},"Enums/CacheType.html#/s:14KukaiCoreSwift9CacheTypeO9temporaryyA2CmF":{"name":"temporary","parent_name":"CacheType"},"Enums/CacheType.html#/s:14KukaiCoreSwift9CacheTypeO9permanentyA2CmF":{"name":"permanent","parent_name":"CacheType"},"Enums/MediaProxyServiceError.html#/s:14KukaiCoreSwift22MediaProxyServiceErrorO28noMimeTypeFoundInsideFormatsyA2CmF":{"name":"noMimeTypeFoundInsideFormats","parent_name":"MediaProxyServiceError"},"Enums/MediaProxyServiceError.html#/s:14KukaiCoreSwift22MediaProxyServiceErrorO24unableToParseContentTypeyA2CmF":{"name":"unableToParseContentType","parent_name":"MediaProxyServiceError"},"Enums/WalletError.html#/s:14KukaiCoreSwift11WalletErrorO09signatureE0yA2CmF":{"name":"signatureError","parent_name":"WalletError"},"Enums/WalletType.html#/s:14KukaiCoreSwift10WalletTypeO7regularyA2CmF":{"name":"regular","parent_name":"WalletType"},"Enums/WalletType.html#/s:14KukaiCoreSwift10WalletTypeO2hdyA2CmF":{"name":"hd","parent_name":"WalletType"},"Enums/WalletType.html#/s:14KukaiCoreSwift10WalletTypeO6socialyA2CmF":{"name":"social","parent_name":"WalletType"},"Enums/WalletType.html#/s:14KukaiCoreSwift10WalletTypeO6ledgeryA2CmF":{"name":"ledger","parent_name":"WalletType"},"Enums/FaVersion.html#/s:14KukaiCoreSwift9FaVersionO5fa1_2yA2CmF":{"name":"fa1_2","parent_name":"FaVersion"},"Enums/FaVersion.html#/s:14KukaiCoreSwift9FaVersionO3fa2yA2CmF":{"name":"fa2","parent_name":"FaVersion"},"Enums/FaVersion.html#/s:14KukaiCoreSwift9FaVersionO7unknownyA2CmF":{"name":"unknown","parent_name":"FaVersion"},"Enums/FaVersion.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"FaVersion"},"Enums/OperationTransactionError.html#/s:14KukaiCoreSwift25OperationTransactionErrorO21invalidMichelsonValueyA2CmF":{"name":"invalidMichelsonValue","parent_name":"OperationTransactionError"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO11transactionyA2CmF":{"name":"transaction","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO6revealyA2CmF":{"name":"reveal","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO10delegationyA2CmF":{"name":"delegation","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO11originationyA2CmF":{"name":"origination","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO16activate_accountyA2CmF":{"name":"activate_account","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO11endorsementyA2CmF":{"name":"endorsement","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO21seed_nonce_revelationyA2CmF":{"name":"seed_nonce_revelation","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO27double_endorsement_evidenceyA2CmF":{"name":"double_endorsement_evidence","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO22double_baking_evidenceyA2CmF":{"name":"double_baking_evidence","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO9proposalsyA2CmF":{"name":"proposals","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO6ballotyA2CmF":{"name":"ballot","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO7unknownyA2CmF":{"name":"unknown","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationKind"},"Enums/OperationKind.html#/s:14KukaiCoreSwift13OperationKindO6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationKind"},"Enums/HDWalletError.html#/s:14KukaiCoreSwift13HDWalletErrorO013invalidWalletbG0yA2CmF":{"name":"invalidWalletCoreWallet","parent_name":"HDWalletError"},"Enums/CurrentDevice.html#/s:14KukaiCoreSwift13CurrentDeviceO11isSimulatorSbvpZ":{"name":"isSimulator","abstract":"

Is the current device a simulator

","parent_name":"CurrentDevice"},"Enums/CurrentDevice.html#/s:14KukaiCoreSwift13CurrentDeviceO23biometricTypeAuthorizedAA09BiometricG0OyFZ":{"name":"biometricTypeAuthorized()","parent_name":"CurrentDevice"},"Enums/CurrentDevice.html#/s:14KukaiCoreSwift13CurrentDeviceO22biometricTypeSupportedAA09BiometricG0OyFZ":{"name":"biometricTypeSupported()","parent_name":"CurrentDevice"},"Enums/BiometricType.html#/s:14KukaiCoreSwift13BiometricTypeO11unavailableyA2CmF":{"name":"unavailable","parent_name":"BiometricType"},"Enums/BiometricType.html#/s:14KukaiCoreSwift13BiometricTypeO4noneyA2CmF":{"name":"none","parent_name":"BiometricType"},"Enums/BiometricType.html#/s:14KukaiCoreSwift13BiometricTypeO7touchIDyA2CmF":{"name":"touchID","parent_name":"BiometricType"},"Enums/BiometricType.html#/s:14KukaiCoreSwift13BiometricTypeO6faceIDyA2CmF":{"name":"faceID","parent_name":"BiometricType"},"Enums/TzKTBakerTiming.html#/s:14KukaiCoreSwift15TzKTBakerTimingO6stableyA2CmF":{"name":"stable","parent_name":"TzKTBakerTiming"},"Enums/TzKTBakerTiming.html#/s:14KukaiCoreSwift15TzKTBakerTimingO8unstableyA2CmF":{"name":"unstable","parent_name":"TzKTBakerTiming"},"Enums/TzKTBakerTiming.html#/s:14KukaiCoreSwift15TzKTBakerTimingO10suspiciousyA2CmF":{"name":"suspicious","parent_name":"TzKTBakerTiming"},"Enums/TzKTBakerTiming.html#/s:14KukaiCoreSwift15TzKTBakerTimingO7no_datayA2CmF":{"name":"no_data","parent_name":"TzKTBakerTiming"},"Enums/TzKTBakerAccuracy.html#/s:14KukaiCoreSwift17TzKTBakerAccuracyO7preciseyA2CmF":{"name":"precise","parent_name":"TzKTBakerAccuracy"},"Enums/TzKTBakerAccuracy.html#/s:14KukaiCoreSwift17TzKTBakerAccuracyO10inaccurateyA2CmF":{"name":"inaccurate","parent_name":"TzKTBakerAccuracy"},"Enums/TzKTBakerAccuracy.html#/s:14KukaiCoreSwift17TzKTBakerAccuracyO10suspiciousyA2CmF":{"name":"suspicious","parent_name":"TzKTBakerAccuracy"},"Enums/TzKTBakerAccuracy.html#/s:14KukaiCoreSwift17TzKTBakerAccuracyO7no_datayA2CmF":{"name":"no_data","parent_name":"TzKTBakerAccuracy"},"Enums/TzKTBakerHealth.html#/s:14KukaiCoreSwift15TzKTBakerHealthO6activeyA2CmF":{"name":"active","parent_name":"TzKTBakerHealth"},"Enums/TzKTBakerHealth.html#/s:14KukaiCoreSwift15TzKTBakerHealthO6closedyA2CmF":{"name":"closed","parent_name":"TzKTBakerHealth"},"Enums/TzKTBakerHealth.html#/s:14KukaiCoreSwift15TzKTBakerHealthO4deadyA2CmF":{"name":"dead","parent_name":"TzKTBakerHealth"},"Enums/DipDupTokenStandard.html#/s:14KukaiCoreSwift19DipDupTokenStandardO4fa12yA2CmF":{"name":"fa12","parent_name":"DipDupTokenStandard"},"Enums/DipDupTokenStandard.html#/s:14KukaiCoreSwift19DipDupTokenStandardO3fa2yA2CmF":{"name":"fa2","parent_name":"DipDupTokenStandard"},"Enums/DipDupTokenStandard.html#/s:14KukaiCoreSwift19DipDupTokenStandardO7unknownyA2CmF":{"name":"unknown","parent_name":"DipDupTokenStandard"},"Enums/DipDupTokenStandard.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"DipDupTokenStandard"},"Enums/DipDupExchangeName.html#/s:14KukaiCoreSwift18DipDupExchangeNameO9quipuswapyA2CmF":{"name":"quipuswap","parent_name":"DipDupExchangeName"},"Enums/DipDupExchangeName.html#/s:14KukaiCoreSwift18DipDupExchangeNameO2lbyA2CmF":{"name":"lb","parent_name":"DipDupExchangeName"},"Enums/DipDupExchangeName.html#/s:14KukaiCoreSwift18DipDupExchangeNameO7unknownyA2CmF":{"name":"unknown","parent_name":"DipDupExchangeName"},"Enums/DipDupExchangeName.html#/s:Se4fromxs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"DipDupExchangeName"},"Enums/ResultExtensionError.html#/s:14KukaiCoreSwift20ResultExtensionErrorO02noF5FoundyA2CmF":{"name":"noErrorFound","parent_name":"ResultExtensionError"},"Enums/ResultExtensionError.html":{"name":"ResultExtensionError"},"Enums/DipDupExchangeName.html":{"name":"DipDupExchangeName","abstract":"

Enum to wrap up the available types of Exchange on DipDup

"},"Enums/DipDupTokenStandard.html":{"name":"DipDupTokenStandard","abstract":"

Wrapping up the FA standards into an enum

"},"Enums/TzKTBakerHealth.html":{"name":"TzKTBakerHealth","abstract":"

The stability of the bakers server

"},"Enums/TzKTBakerAccuracy.html":{"name":"TzKTBakerAccuracy","abstract":"

The accuracy of the bakers payments

"},"Enums/TzKTBakerTiming.html":{"name":"TzKTBakerTiming","abstract":"

The reliability of the bakers payouts

"},"Enums/BiometricType.html":{"name":"BiometricType"},"Enums/CurrentDevice.html":{"name":"CurrentDevice","abstract":"

Enum used to get details about the current device’s capabilities

"},"Enums/HDWalletError.html":{"name":"HDWalletError","abstract":"

Error types that can be passed by failable inits

"},"Enums/OperationKind.html":{"name":"OperationKind","abstract":"

Enum representing the various kinds of supported Operation‘s

"},"Enums/OperationTransactionError.html":{"name":"OperationTransactionError"},"Enums/FaVersion.html":{"name":"FaVersion","abstract":"

Enum representing the version of tezos “FA” token contracts

"},"Enums/WalletType.html":{"name":"WalletType","abstract":"

Enum to distingush between linear (non-hd) wallets, using the Bip39 standard, and hd wallets using the Bip44 standard.

"},"Enums/WalletError.html":{"name":"WalletError","abstract":"

Possible error types that can occur when using the LedgerWallet

"},"Enums/MediaProxyServiceError.html":{"name":"MediaProxyServiceError"},"Enums/CacheType.html":{"name":"CacheType"},"Enums/DAppCategory.html":{"name":"DAppCategory"},"Enums/DAppAccessType.html":{"name":"DAppAccessType"},"Enums/TorusAuthProvider.html":{"name":"TorusAuthProvider","abstract":"

List of providers currently supported and available on the Tezos network

"},"Enums/TorusAuthError.html":{"name":"TorusAuthError","abstract":"

Custom TorusAuthService errors that cna be thrown

"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceCACycfc":{"name":"init()","abstract":"

Empty

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC5cache6wallet12childOfIndex8backedUpSbx_SiSgSbtAA0D0RzlF":{"name":"cache(wallet:childOfIndex:backedUp:)","abstract":"

Securely cache a walelt object, and record a default metadata object

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC010cacheWatchD08metadataSbAA0D8MetadataV_tF":{"name":"cacheWatchWallet(metadata:)","abstract":"

Cahce a watch wallet metadata obj, only. Metadata cahcing handled via wallet cache method

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC06deleteD011withAddress11parentIndexSbSS_SiSgtF":{"name":"deleteWallet(withAddress:parentIndex:)","abstract":"

Delete both a secure wallet entry and its related metadata object

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC011deleteWatchD07addressSbSS_tF":{"name":"deleteWatchWallet(address:)","abstract":"

Clear a watch wallet meatadata obj from the metadata cache only, does not affect actual wallet cache

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC05fetchD010forAddressAA0D0_pSgSS_tF":{"name":"fetchWallet(forAddress:)","abstract":"

Find and return the secure object for a given address

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC09deleteAllE7AndKeysSbyF":{"name":"deleteAllCacheAndKeys()","abstract":"

Delete the cached files and the assoicate keys used to encrypt it

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC28encryptAndWriteWalletsToDisk7walletsSbSDySSAA0D0_pG_tF":{"name":"encryptAndWriteWalletsToDisk(wallets:)","abstract":"

Take a dictionary of Wallet objects with their addresses as the key, serialise to JSON, encrypt and then write to disk

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC29readWalletsFromDiskAndDecryptSDySSAA0D0_pGSgyF":{"name":"readWalletsFromDiskAndDecrypt()","abstract":"

Go to the file on disk (if present), decrypt its contents and retrieve a dictionary of `Wallet’s with the key being the wallet address

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC29encryptAndWriteMetadataToDiskySbAA0dJ4ListVF":{"name":"encryptAndWriteMetadataToDisk(_:)","abstract":"

Write an ordered array of WalletMetadata to disk, replacing existing file if exists

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC30readMetadataFromDiskAndDecryptAA0dH4ListVyF":{"name":"readMetadataFromDiskAndDecrypt()","abstract":"

Return an ordered array of WalletMetadata if present on disk

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC16loadOrCreateKeysSbyF":{"name":"loadOrCreateKeys()","abstract":"

Load the key references from the secure enclave (or keychain), or create them if non exist

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC10unloadKeysyyF":{"name":"unloadKeys()","abstract":"

Clear the key refrences

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC9deleteKeyyyKF":{"name":"deleteKey()","abstract":"

Delete a key from the secure enclave

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC7encrypty10Foundation4DataVSSKF":{"name":"encrypt(_:)","abstract":"

Encrypts string using the Secure Enclave

","parent_name":"WalletCacheService"},"Classes/WalletCacheService.html#/s:14KukaiCoreSwift18WalletCacheServiceC7decryptySS10Foundation4DataVKF":{"name":"decrypt(_:)","abstract":"

Decrypts cipher text using the Secure Enclave

","parent_name":"WalletCacheService"},"Classes/TorusAuthService.html#/s:14KukaiCoreSwift16TorusAuthServiceC07networkF09verifiersAcA07NetworkF0C_SDyAA0dE8ProviderOAA18SubverifierWrapperVGtcfc":{"name":"init(networkService:verifiers:)","abstract":"

Setup the TorusAuthService verifiers and networking clients for testnet and mainnet, so they can be queried easier.

","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/s:14KukaiCoreSwift16TorusAuthServiceC12createWallet4from11displayOver06mockedD010completionyAA0dE8ProviderO_So16UIViewControllerCSg06CustomE0ANCSgys6ResultOyAA0dH0CAA0A5ErrorVGctF":{"name":"createWallet(from:displayOver:mockedTorus:completion:)","abstract":"

Create a TorusWallet insteace from a social media provider

","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/s:14KukaiCoreSwift16TorusAuthServiceC10getAddress4from3for10completionyAA0dE8ProviderO_SSys6ResultOySSAA0A5ErrorVGctF":{"name":"getAddress(from:for:completion:)","abstract":"

Get a TZ2 address from a social media user name. If Twitter, will first convert the username to a userid and then query

","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/s:14KukaiCoreSwift16TorusAuthServiceC13twitterLookup8username10completionySS_ys6ResultOySSAA0A5ErrorVGctF":{"name":"twitterLookup(username:completion:)","abstract":"

Take in a Twitter username and fetch the Twitter userId instead.

","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/c:@CM@KukaiCoreSwift@objc(cs)TorusAuthService(im)presentationAnchorForAuthorizationController:":{"name":"presentationAnchor(for:)","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/c:@CM@KukaiCoreSwift@objc(cs)TorusAuthService(im)authorizationController:didCompleteWithError:":{"name":"authorizationController(controller:didCompleteWithError:)","parent_name":"TorusAuthService"},"Classes/TorusAuthService.html#/c:@CM@KukaiCoreSwift@objc(cs)TorusAuthService(im)authorizationController:didCompleteWithAuthorization:":{"name":"authorizationController(controller:didCompleteWithAuthorization:)","parent_name":"TorusAuthService"},"Classes/TaquitoService/TaquitoServiceError.html#/s:14KukaiCoreSwift14TaquitoServiceC0dE5ErrorO14alreadyForgingyA2EmF":{"name":"alreadyForging","parent_name":"TaquitoServiceError"},"Classes/TaquitoService/TaquitoServiceError.html#/s:14KukaiCoreSwift14TaquitoServiceC0dE5ErrorO14alreadyParsingyA2EmF":{"name":"alreadyParsing","parent_name":"TaquitoServiceError"},"Classes/TaquitoService/TaquitoServiceError.html":{"name":"TaquitoServiceError","abstract":"

Unique TaquitoService errors

","parent_name":"TaquitoService"},"Classes/TaquitoService.html#/s:14KukaiCoreSwift14TaquitoServiceC6sharedACvpZ":{"name":"shared","abstract":"

Public shared instace to avoid having multiple copies of the underlying JSContext created

","parent_name":"TaquitoService"},"Classes/TaquitoService.html#/s:14KukaiCoreSwift14TaquitoServiceC5forge16operationPayload10completionyAA09OperationH0V_ys6ResultOySSAA0A5ErrorVGctF":{"name":"forge(operationPayload:completion:)","abstract":"

Wrapper around the node package @taquito/local-forging’s forge method. Giving the ability to locally forge an OperationPayload without using an RPC, and avoiding the need to do an RPC parse against a second server.","parent_name":"TaquitoService"},"Classes/TaquitoService.html#/s:14KukaiCoreSwift14TaquitoServiceC5parse3hex10completionySS_ys6ResultOyAA16OperationPayloadVAA0A5ErrorVGctF":{"name":"parse(hex:completion:)","abstract":"

Wrapper around the node package @taquito/local-forging’s prase method. Giving the ability to locally parse a hex string back into an OperationPayload, without the need to use an RPC on a tezos node.","parent_name":"TaquitoService"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV7payloadAA0dG0Vvp":{"name":"payload","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV8forgedOpSSvp":{"name":"forgedOp","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV13watermarkedOpSSvp":{"name":"watermarkedOp","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV11blake2bHashSSvp":{"name":"blake2bHash","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV8metadataAA0D8MetadataVvp":{"name":"metadata","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/LedgerPayloadPrepResponse.html#/s:14KukaiCoreSwift16OperationServiceC25LedgerPayloadPrepResponseV03canF5ParseSbvp":{"name":"canLedgerParse","parent_name":"LedgerPayloadPrepResponse"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO18unableToSetupForgeyA2EmF":{"name":"unableToSetupForge","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO18unableToSetupParseyA2EmF":{"name":"unableToSetupParse","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO11parseFailedyA2EmF":{"name":"parseFailed","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO14signingFailureyA2EmF":{"name":"signingFailure","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO21unableToSetupPreapplyyA2EmF":{"name":"unableToSetupPreapply","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO017preapplyContainedF0yAESayAA0d22ResponseInternalResultF0VGSg_tcAEmF":{"name":"preapplyContainedError(errors:)","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO19unableToSetupInjectyA2EmF":{"name":"unableToSetupInject","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html#/s:14KukaiCoreSwift16OperationServiceC0dE5ErrorO21noRemoteParseURLFoundyA2EmF":{"name":"noRemoteParseURLFound","parent_name":"OperationServiceError"},"Classes/OperationService/OperationServiceError.html":{"name":"OperationServiceError","abstract":"

Errors that the OperationService is capable of returning

","parent_name":"OperationService"},"Classes/OperationService/LedgerPayloadPrepResponse.html":{"name":"LedgerPayloadPrepResponse","abstract":"

Used to return a bunch of formatted data, to make interacting with ledger sign operation easier

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC6configAA21TezosNodeClientConfigVvp":{"name":"config","abstract":"

The configuration object containing all the necessary settings to connect and communicate with the Tezos node

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC07networkE0AA07NetworkE0Cvp":{"name":"networkService","abstract":"

The NetworkService object that will perform all the networking calls

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC6config07networkE0AcA21TezosNodeClientConfigV_AA07NetworkE0Ctcfc":{"name":"init(config:networkService:)","abstract":"

Init a TezosNodeClient with a TezosNodeClientConfig.

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC34remoteForgeParseSignPreapplyInject17operationMetadata0L7Payload6wallet10completionyAA0dM0V_AA0dN0VAA6Wallet_pys6ResultOySSAA0A5ErrorVGctF":{"name":"remoteForgeParseSignPreapplyInject(operationMetadata:operationPayload:wallet:completion:)","abstract":"

When using remote forging, every Operation needs to be Forged, Parsed, Signed, Preapply’d and Injected to make its way into the blockchain.","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC28localForgeSignPreapplyInject17operationMetadata0K7Payload6wallet10completionyAA0dL0V_AA0dM0VAA6Wallet_pys6ResultOySSAA0A5ErrorVGctF":{"name":"localForgeSignPreapplyInject(operationMetadata:operationPayload:wallet:completion:)","abstract":"

When using local forging, every Operation needs to be Forged, Signed, Preapply’d and Injected to make its way into the blockchain.","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC18ledgerStringToSign10forgedHash16operationPayloadS2S_AA0dM0VtF":{"name":"ledgerStringToSign(forgedHash:operationPayload:)","abstract":"

Ledger can only parse operations under certain conditions. These conditions are not documented well. This function will attempt to determine whether the payload can be parsed or not, and returnt he appropriate string for the LedgerWallet sign function","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC17preapplyAndInject06forgedD09signature0J5Curve16operationPayload0L8Metadata10completionySS_Says5UInt8VG0a6CryptoC0010EllipticalK0OAA0dM0VAA0dN0Vys6ResultOySSAA0A5ErrorVGctF":{"name":"preapplyAndInject(forgedOperation:signature:signatureCurve:operationPayload:operationMetadata:completion:)","abstract":"

Preapply and Inject wrapped up as one function, for situations like Ledger Wallets, where signing is a complately different process, and must be done elsewhere

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC11remoteForge16operationPayload10completionyAA0dI0V_ys6ResultOySSAA0A5ErrorVGctF":{"name":"remoteForge(operationPayload:completion:)","abstract":"

Forge an OperationPayload remotely, so it can be sent to the RPC.

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC11remoteParse11forgeResult17operationMetadata0J7Payload10completionys0I0OySSAA0A5ErrorVG_AA0dK0VAA0dL0VyAMctF":{"name":"remoteParse(forgeResult:operationMetadata:operationPayload:completion:)","abstract":"

Parse a forged OperationPayload on a different server to ensure nobody maliciously tampared with the request.

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC8preapply16operationPayload10completionyAA0dH0V_ys6ResultOySayAA0D8ResponseVGAA0A5ErrorVGctF":{"name":"preapply(operationPayload:completion:)","abstract":"

Preapply a signed OperationPayload to check for any errors.

","parent_name":"OperationService"},"Classes/OperationService.html#/s:14KukaiCoreSwift16OperationServiceC6inject11signedBytes20handlePreapplyResult10completionySS_s0K0OySayAA0D8ResponseVGAA0A5ErrorVGSgyAIySSANGctF":{"name":"inject(signedBytes:handlePreapplyResult:completion:)","abstract":"

Inject a signed bytes to become part of the next block on the blockchain

","parent_name":"OperationService"},"Classes/NetworkService/NetworkError.html#/s:14KukaiCoreSwift14NetworkServiceC0D5ErrorO5parseyAESS_tcAEmF":{"name":"parse(error:)","parent_name":"NetworkError"},"Classes/NetworkService/NetworkError.html#/s:14KukaiCoreSwift14NetworkServiceC0D5ErrorO10invalidURLyA2EmF":{"name":"invalidURL","parent_name":"NetworkError"},"Classes/NetworkService/NetworkError.html#/s:14KukaiCoreSwift14NetworkServiceC0D5ErrorO7unknownyA2EmF":{"name":"unknown","parent_name":"NetworkError"},"Classes/NetworkService/NetworkError.html#/s:14KukaiCoreSwift14NetworkServiceC0D5ErrorO04httpF0yAESi_SSSgtcAEmF":{"name":"httpError(statusCode:response:)","parent_name":"NetworkError"},"Classes/NetworkService/NetworkError.html":{"name":"NetworkError","abstract":"

Errors that can be returned by the NetworkService

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC10urlSessionSo12NSURLSessionCvp":{"name":"urlSession","abstract":"

The URLSession used to preform all the networking operations

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC13loggingConfigAA07LoggingG0Vvp":{"name":"loggingConfig","abstract":"

The URLSession used to preform all the networking operations

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC10urlSession13loggingConfigACSo12NSURLSessionC_AA07LoggingI0Vtcfc":{"name":"init(urlSession:loggingConfig:)","abstract":"

Init an NetworkService with a URLSession

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC4send3rpc11withBaseURL10completionyAA3RPCCyxG_10Foundation0J0Vys6ResultOyxAA0A5ErrorVGctSeRzlF":{"name":"send(rpc:withBaseURL:completion:)","abstract":"

A generic send function that takes an RPC, with a generic type conforming to Decodable, executes the request and returns the result.

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC7request3url6isPOST8withBody13forReturnType10completiony10Foundation3URLV_SbAJ4DataVSgxmys6ResultOyxAA0A5ErrorVGctSeRzlF":{"name":"request(url:isPOST:withBody:forReturnType:completion:)","abstract":"

A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response.","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC7request3url6isPOST8withBody13forReturnType7Combine12AnyPublisherVyxAA0A5ErrorVG10Foundation3URLV_SbAO4DataVSgxmtSeRzlF":{"name":"request(url:isPOST:withBody:forReturnType:)","abstract":"

A generic network request function that takes a URL, optional payload and a Decodable response type. Function will execute the request and attempt to parse the response, returning it as a combine publisher.","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC16logRequestFailed13loggingConfig6isPost7fullURL7payload5error10statusCode12responseDatayAA07LoggingJ0VSg_Sb10Foundation0N0VAO0T0VSgs5Error_pSgSiSgATtFZ":{"name":"logRequestFailed(loggingConfig:isPost:fullURL:payload:error:statusCode:responseData:)","abstract":"

Logging details of request failures using os_log global logging

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC18logRequestSucceded13loggingConfig6isPost7fullURL7payload12responseDatayAA07LoggingJ0VSg_Sb10Foundation0N0VAM0Q0VSgARtFZ":{"name":"logRequestSucceded(loggingConfig:isPost:fullURL:payload:responseData:)","abstract":"

Logging details of successful requests using os_log global logging

","parent_name":"NetworkService"},"Classes/NetworkService.html#/s:14KukaiCoreSwift14NetworkServiceC15logRequestStart13loggingConfig7fullURLyAA07LoggingJ0VSg_10Foundation0L0VtFZ":{"name":"logRequestStart(loggingConfig:fullURL:)","abstract":"

Logging details when a request starts using os_log global logging

","parent_name":"NetworkService"},"Classes/ContentTypeCheckingImageDownloader.html#/s:14KukaiCoreSwift34ContentTypeCheckingImageDownloaderC17startDownloadTask7context8callback10Kingfisher0jK0VAG0gH0C18DownloadingContextV_AG011SessionDataK0C0K8CallbackVtF":{"name":"startDownloadTask(context:callback:)","parent_name":"ContentTypeCheckingImageDownloader"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO9imageOnlyyA2EmF":{"name":"imageOnly","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO9audioOnlyyA2EmF":{"name":"audioOnly","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO9videoOnlyyA2EmF":{"name":"videoOnly","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO7gifOnlyyA2EmF":{"name":"gifOnly","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/AggregatedMediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC010AggregatedD4TypeO13imageAndAudioyA2EmF":{"name":"imageAndAudio","parent_name":"AggregatedMediaType"},"Classes/MediaProxyService/MediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC0D4TypeO5imageyA2EmF":{"name":"image","parent_name":"MediaType"},"Classes/MediaProxyService/MediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC0D4TypeO5audioyA2EmF":{"name":"audio","parent_name":"MediaType"},"Classes/MediaProxyService/MediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC0D4TypeO5videoyA2EmF":{"name":"video","parent_name":"MediaType"},"Classes/MediaProxyService/MediaType.html#/s:14KukaiCoreSwift17MediaProxyServiceC0D4TypeO3gifyA2EmF":{"name":"gif","parent_name":"MediaType"},"Classes/MediaProxyService/Source.html#/s:14KukaiCoreSwift17MediaProxyServiceC6SourceO4ipfsyA2EmF":{"name":"ipfs","parent_name":"Source"},"Classes/MediaProxyService/Source.html#/s:14KukaiCoreSwift17MediaProxyServiceC6SourceO3webyA2EmF":{"name":"web","parent_name":"Source"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO4iconyA2EmF":{"name":"icon","parent_name":"Format"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO5smallyA2EmF":{"name":"small","parent_name":"Format"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO6mediumyA2EmF":{"name":"medium","parent_name":"Format"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO7galleryyA2EmF":{"name":"gallery","parent_name":"Format"},"Classes/MediaProxyService/Format.html#/s:14KukaiCoreSwift17MediaProxyServiceC6FormatO3rawyA2EmF":{"name":"raw","parent_name":"Format"},"Classes/MediaProxyService/Format.html":{"name":"Format","abstract":"

Enum denoting the avaialble sizes for media

","parent_name":"MediaProxyService"},"Classes/MediaProxyService/Source.html":{"name":"Source","abstract":"

Supported source types for proxied media

","parent_name":"MediaProxyService"},"Classes/MediaProxyService/MediaType.html":{"name":"MediaType","abstract":"

Supported media types

","parent_name":"MediaProxyService"},"Classes/MediaProxyService/AggregatedMediaType.html":{"name":"AggregatedMediaType","abstract":"

Helper to parse a collection of media types to understand its contents

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC3url13fromUriString8ofFormat7keepGif10Foundation3URLVSgSSSg_AC0L0OSbtFZ":{"name":"url(fromUriString:ofFormat:keepGif:)","abstract":"

Take a URI from a token metadata response and convert it to a useable media proxy URL

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC3url7fromUri8ofFormat7keepGif10Foundation3URLVSgAK_AC0K0OSbtFZ":{"name":"url(fromUri:ofFormat:keepGif:)","abstract":"

Take a URI from a token metadata response and convert it to a useable media proxy URL

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC12thumbnailURL6forNFT7keepGif10Foundation0H0VSgAA0J0V_SbtFZ":{"name":"thumbnailURL(forNFT:keepGif:)","abstract":"

Helper method to return a standard thumbnail URL for a NFT, taking into account some custom logic / known workarounds

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC10displayURL6forNFT7keepGif10Foundation0H0VSgAA0J0V_SbtFZ":{"name":"displayURL(forNFT:keepGif:)","abstract":"

Helper method to return a standard larger display URL for a NFT

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC03getD4Type11fromFormatsSayAC0dH0OGSayAA25TzKTBalanceMetadataFormatVG_tFZ":{"name":"getMediaType(fromFormats:)","abstract":"

Using only info from TzKTBalanceMetadataFormat determine the media type(s) of the object

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC03getD4Type11fromFormats5orURL10urlSession10completionySayAA25TzKTBalanceMetadataFormatVG_10Foundation0L0VSgSo12NSURLSessionCys6ResultOySayAC0dH0OGAA0A5ErrorVGctF":{"name":"getMediaType(fromFormats:orURL:urlSession:completion:)","abstract":"

Given multiple sources of information, attempt to find the media type the url is pointing too

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC13typesContentsyAC010AggregatedD4TypeOSgSayAC0dJ0OGFZ":{"name":"typesContents(_:)","abstract":"

Helper method to parse an array of MediaType to quickly determine its content type so UI can be easily arraged

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC15removeAllImages10completionyyyc_tFZ":{"name":"removeAllImages(completion:)","abstract":"

Clear all images from all caches

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC15removeAllImages9fromCache10completionyAA0K4TypeO_yyctFZ":{"name":"removeAllImages(fromCache:completion:)","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC18clearExpiredImagesyyFZ":{"name":"clearExpiredImages()","abstract":"

Clear only iamges from cahce that have expired

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC6sizeOf5cacheSuAA9CacheTypeO_tFZ":{"name":"sizeOf(cache:)","abstract":"

Get size in bytes

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC4load3url2to13withCacheType8fallback14downSampleSize10completiony10Foundation3URLVSg_So11UIImageViewCAA0kL0OSo0T0CSo6CGSizeVSgyAWcSgtFZ":{"name":"load(url:to:withCacheType:fallback:downSampleSize:completion:)","abstract":"

Attempt to use KingFisher library to load an image from a URL, into an UIImageView, with support for downsampling, displaying loading spinner, svgs, gifs and the permanent / temporary caching system

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC10imageCache7forType10Kingfisher05ImageH0CAA0hJ0O_tFZ":{"name":"imageCache(forType:)","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC10cacheImage3url0G4Type10completiony10Foundation3URLVSg_AA05CacheJ0OySo6CGSizeVSgctFZ":{"name":"cacheImage(url:cacheType:completion:)","abstract":"

Attempt to use KingFisher library to load an image from a URL, and store it directly in the cache for later usage. Also optional return the downloaded size via a completion block, useful for preparing table/collection view

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC8isCached3url9cacheTypeSb10Foundation3URLVSg_AA05CacheK0OtFZ":{"name":"isCached(url:cacheType:)","abstract":"

Check if a given url is already cached

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/s:14KukaiCoreSwift17MediaProxyServiceC20sizeForImageIfCached3url9cacheType10completiony10Foundation3URLVSg_AA05CacheN0OySo6CGSizeVSgctFZ":{"name":"sizeForImageIfCached(url:cacheType:completion:)","abstract":"

Check if an image is cached, and return its size if so. Useful for preparing table/collection view

","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/c:@CM@KukaiCoreSwift@objc(cs)MediaProxyService(im)URLSession:downloadTask:didFinishDownloadingToURL:":{"name":"urlSession(_:downloadTask:didFinishDownloadingTo:)","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/c:@CM@KukaiCoreSwift@objc(cs)MediaProxyService(im)URLSession:task:didCompleteWithError:":{"name":"urlSession(_:task:didCompleteWithError:)","parent_name":"MediaProxyService"},"Classes/MediaProxyService.html#/c:@CM@KukaiCoreSwift@objc(cs)MediaProxyService(im)URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:":{"name":"urlSession(_:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite:)","parent_name":"MediaProxyService"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO15EXC_WRONG_PARAMyA2EmF":{"name":"EXC_WRONG_PARAM","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO16EXC_WRONG_LENGTHyA2EmF":{"name":"EXC_WRONG_LENGTH","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO15EXC_INVALID_INSyA2EmF":{"name":"EXC_INVALID_INS","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO24EXC_WRONG_LENGTH_FOR_INSyA2EmF":{"name":"EXC_WRONG_LENGTH_FOR_INS","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO10EXC_REJECTyA2EmF":{"name":"EXC_REJECT","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO15EXC_PARSE_ERRORyA2EmF":{"name":"EXC_PARSE_ERROR","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO29EXC_REFERENCED_DATA_NOT_FOUNDyA2EmF":{"name":"EXC_REFERENCED_DATA_NOT_FOUND","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO16EXC_WRONG_VALUESyA2EmF":{"name":"EXC_WRONG_VALUES","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO12EXC_SECURITYyA2EmF":{"name":"EXC_SECURITY","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO16EXC_HID_REQUIREDyA2EmF":{"name":"EXC_HID_REQUIRED","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO9EXC_CLASSyA2EmF":{"name":"EXC_CLASS","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/TezosAppErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC18TezosAppErrorCodesO16EXC_MEMORY_ERRORyA2EmF":{"name":"EXC_MEMORY_ERROR","parent_name":"TezosAppErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO22PIN_REMAINING_ATTEMPTSyA2EmF":{"name":"PIN_REMAINING_ATTEMPTS","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO16INCORRECT_LENGTHyA2EmF":{"name":"INCORRECT_LENGTH","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO26MISSING_CRITICAL_PARAMETERyA2EmF":{"name":"MISSING_CRITICAL_PARAMETER","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO35COMMAND_INCOMPATIBLE_FILE_STRUCTUREyA2EmF":{"name":"COMMAND_INCOMPATIBLE_FILE_STRUCTURE","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO29SECURITY_STATUS_NOT_SATISFIEDyA2EmF":{"name":"SECURITY_STATUS_NOT_SATISFIED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO31CONDITIONS_OF_USE_NOT_SATISFIEDyA2EmF":{"name":"CONDITIONS_OF_USE_NOT_SATISFIED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14INCORRECT_DATAyA2EmF":{"name":"INCORRECT_DATA","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO23NOT_ENOUGH_MEMORY_SPACEyA2EmF":{"name":"NOT_ENOUGH_MEMORY_SPACE","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO25REFERENCED_DATA_NOT_FOUNDyA2EmF":{"name":"REFERENCED_DATA_NOT_FOUND","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO19FILE_ALREADY_EXISTSyA2EmF":{"name":"FILE_ALREADY_EXISTS","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO15INCORRECT_P1_P2yA2EmF":{"name":"INCORRECT_P1_P2","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17INS_NOT_SUPPORTEDyA2EmF":{"name":"INS_NOT_SUPPORTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17CLA_NOT_SUPPORTEDyA2EmF":{"name":"CLA_NOT_SUPPORTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17TECHNICAL_PROBLEMyA2EmF":{"name":"TECHNICAL_PROBLEM","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14MEMORY_PROBLEMyA2EmF":{"name":"MEMORY_PROBLEM","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14NO_EF_SELECTEDyA2EmF":{"name":"NO_EF_SELECTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14INVALID_OFFSETyA2EmF":{"name":"INVALID_OFFSET","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14FILE_NOT_FOUNDyA2EmF":{"name":"FILE_NOT_FOUND","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17INCONSISTENT_FILEyA2EmF":{"name":"INCONSISTENT_FILE","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO23ALGORITHM_NOT_SUPPORTEDyA2EmF":{"name":"ALGORITHM_NOT_SUPPORTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO11INVALID_KCVyA2EmF":{"name":"INVALID_KCV","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO20CODE_NOT_INITIALIZEDyA2EmF":{"name":"CODE_NOT_INITIALIZED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO30ACCESS_CONDITION_NOT_FULFILLEDyA2EmF":{"name":"ACCESS_CONDITION_NOT_FULFILLED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO32CONTRADICTION_SECRET_CODE_STATUSyA2EmF":{"name":"CONTRADICTION_SECRET_CODE_STATUS","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO26CONTRADICTION_INVALIDATIONyA2EmF":{"name":"CONTRADICTION_INVALIDATION","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO12CODE_BLOCKEDyA2EmF":{"name":"CODE_BLOCKED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO17MAX_VALUE_REACHEDyA2EmF":{"name":"MAX_VALUE_REACHED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO14GP_AUTH_FAILEDyA2EmF":{"name":"GP_AUTH_FAILED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO9LICENSINGyA2EmF":{"name":"LICENSING","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO6HALTEDyA2EmF":{"name":"HALTED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO13DEVICE_LOCKEDyA2EmF":{"name":"DEVICE_LOCKED","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO7UNKNOWNyA2EmF":{"name":"UNKNOWN","parent_name":"GeneralErrorCodes"},"Classes/LedgerService/GeneralErrorCodes.html#/s:14KukaiCoreSwift13LedgerServiceC17GeneralErrorCodesO23NO_WRITE_CHARACTERISTICyA2EmF":{"name":"NO_WRITE_CHARACTERISTIC","parent_name":"GeneralErrorCodes"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC11successCodeSSvpZ":{"name":"successCode","abstract":"

Instead of returning data, sometimes ledger returns a code to indicate that so far the message have been received successfully

","parent_name":"LedgerService"},"Classes/LedgerService/GeneralErrorCodes.html":{"name":"GeneralErrorCodes","abstract":"

General Ledger error codes, pulled from the source, and some additional ones added for native swift issues

","parent_name":"LedgerService"},"Classes/LedgerService/TezosAppErrorCodes.html":{"name":"TezosAppErrorCodes","abstract":"

Dedicated error codes pulled from the Ledger tezos app

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC29partialSuccessMessageReceivedSbvp":{"name":"partialSuccessMessageReceived","abstract":"

Be notified when the ledger device returns a success message, part way through the process.","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC6sharedACvpZ":{"name":"shared","abstract":"

Public shared instace to avoid having multiple copies of the underlying JSContext created

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC16listenForDevices7Combine12AnyPublisherVySDyS2SGAA0A5ErrorVGyF":{"name":"listenForDevices()","abstract":"

Start listening for ledger devices

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC13stopListeningyyF":{"name":"stopListening()","abstract":"

Stop listening for and reporting new ledger devices found

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC9connectTo4uuid7Combine12AnyPublisherVySbAA0A5ErrorVGSS_tF":{"name":"connectTo(uuid:)","abstract":"

Connect to a ledger device by a given UUID

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC20disconnectFromDeviceyyF":{"name":"disconnectFromDevice()","abstract":"

Disconnect from the current Ledger device

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC22getConnectedDeviceUUIDSSSgyF":{"name":"getConnectedDeviceUUID()","abstract":"

Get the UUID of the connected device

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC10getAddress17forDerivationPath5curve6verify7Combine12AnyPublisherVySS7address_SS9publicKeytAA0A5ErrorVGSS_0a6CryptoC015EllipticalCurveOSbtF":{"name":"getAddress(forDerivationPath:curve:verify:)","abstract":"

Get a TZ address and public key from the current connected Ledger device

","parent_name":"LedgerService"},"Classes/LedgerService.html#/s:14KukaiCoreSwift13LedgerServiceC4sign3hex17forDerivationPath5parse7Combine12AnyPublisherVySSAA0A5ErrorVGSS_SSSbtF":{"name":"sign(hex:forDerivationPath:parse:)","abstract":"

Sign an operation payload with the underlying secret key, returning the signature

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)centralManagerDidUpdateState:":{"name":"centralManagerDidUpdateState(_:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)centralManager:didDiscoverPeripheral:advertisementData:RSSI:":{"name":"centralManager(_:didDiscover:advertisementData:rssi:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)centralManager:didConnectPeripheral:":{"name":"centralManager(_:didConnect:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)centralManager:didFailToConnectPeripheral:error:":{"name":"centralManager(_:didFailToConnect:error:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)peripheral:didDiscoverServices:":{"name":"peripheral(_:didDiscoverServices:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)peripheral:didDiscoverCharacteristicsForService:error:":{"name":"peripheral(_:didDiscoverCharacteristicsFor:error:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)peripheral:didWriteValueForCharacteristic:error:":{"name":"peripheral(_:didWriteValueFor:error:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/LedgerService.html#/c:@M@KukaiCoreSwift@objc(cs)LedgerService(im)peripheral:didUpdateValueForCharacteristic:error:":{"name":"peripheral(_:didUpdateValueFor:error:)","abstract":"

CBCentralManagerDelegate function, must be marked public because of protocol definition

","parent_name":"LedgerService"},"Classes/FeeEstimatorService/EstimationResult.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC16EstimationResultV10operationsSayAA9OperationCGvp":{"name":"operations","parent_name":"EstimationResult"},"Classes/FeeEstimatorService/EstimationResult.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC16EstimationResultV12forgedStringSSvp":{"name":"forgedString","parent_name":"EstimationResult"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO25tezosNodeClientNotPresentyA2EmF":{"name":"tezosNodeClientNotPresent","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO25unableToSetupRunOperationyA2EmF":{"name":"unableToSetupRunOperation","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO27invalidNumberOfFeesReturnedyA2EmF":{"name":"invalidNumberOfFeesReturned","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO22failedToCopyOperationsyA2EmF":{"name":"failedToCopyOperations","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO016estimationRemoteG0yAESayAA031OperationResponseInternalResultG0VGSg_tcAEmF":{"name":"estimationRemoteError(errors:)","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0deF5ErrorO30unsupportedWalletAddressPrefixyA2EmF":{"name":"unsupportedWalletAddressPrefix","parent_name":"FeeEstimatorServiceError"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV15nanoTezPerMutezSivpZ":{"name":"nanoTezPerMutez","parent_name":"FeeConstants"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV07minimalD0SivpZ":{"name":"minimalFee","parent_name":"FeeConstants"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV13feePerGasUnitSivpZ":{"name":"feePerGasUnit","parent_name":"FeeConstants"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV17feePerStorageByteSivpZ":{"name":"feePerStorageByte","parent_name":"FeeConstants"},"Classes/FeeEstimatorService/FeeConstants.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC0D9ConstantsV04baseD0AA9XTZAmountCvpZ":{"name":"baseFee","parent_name":"FeeConstants"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC16defaultSignatureSays5UInt8VGvpZ":{"name":"defaultSignature","abstract":"

The real signature is not needed for estimation, use the default “Zero Signature” instead

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC19defaultSignatureHexSSvpZ":{"name":"defaultSignatureHex","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService/FeeConstants.html":{"name":"FeeConstants","abstract":"

Constants needed to compute a fee

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService/FeeEstimatorServiceError.html":{"name":"FeeEstimatorServiceError","abstract":"

Various possible errors that can occur during an Estimation

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService/EstimationResult.html":{"name":"EstimationResult","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC6configAA21TezosNodeClientConfigVvp":{"name":"config","abstract":"

The configuration object containing all the necessary settings to connect and communicate with the Tezos node

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC09operationF0AA09OperationF0Cvp":{"name":"operationService","abstract":"

The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC07networkF0AA07NetworkF0Cvp":{"name":"networkService","abstract":"

The NetworkService that will handle the remote communication.

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC6config09operationF007networkF0AcA21TezosNodeClientConfigV_AA09OperationF0CAA07NetworkF0Ctcfc":{"name":"init(config:operationService:networkService:)","abstract":"

Create a FeeEstimatorService that will allow developers to automatically create fees on the users behalf

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC8estimate10operations17operationMetadata9constants13walletAddress22base58EncodedPublicKey10completionySayAA9OperationCG_AA0sJ0VAA16NetworkConstantsVS2Sys6ResultOyAC010EstimationV0VAA0A5ErrorVGctF":{"name":"estimate(operations:operationMetadata:constants:walletAddress:base58EncodedPublicKey:completion:)","abstract":"

Pass in an array of Operation subclasses (use OperationFacotry to create) to have the library estimate the cost of sending the transaction. Function will use local or remote forging based off config passed in.","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC11extractFees21fromOperationResponse10forgedHash13withConstantsSayAA0jH0VGAA0jK0V_SSAA07NetworkO0VtF":{"name":"extractFees(fromOperationResponse:forgedHash:withConstants:)","abstract":"

Create an array of OperationFees from an OperationResponse.

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC9feeForGasyAA9XTZAmountCSiFZ":{"name":"feeForGas(_:)","abstract":"

Calculate the fee to add for the given amount of gas

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC13feeForStorage_18numberOfOperationsAA9XTZAmountCSS_SitFZ":{"name":"feeForStorage(_:numberOfOperations:)","abstract":"

Calculate the fee to add based on the size of the forged string

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC10feeForBurn_13withConstantsAA9XTZAmountCSi_AA07NetworkK0VtFZ":{"name":"feeForBurn(_:withConstants:)","abstract":"

Calculate the fee to add based on how many bytes of storage where needed

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC12nanoTeztoXTZyAA9XTZAmountCSiFZ":{"name":"nanoTeztoXTZ(_:)","abstract":"

Most calcualtions are documented in NanoTez, which is not accpeted by the network RPC calls. Needs to be converted to Mutez / XTZ

","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC3fee11forGasLimit15forgedHexString18numberOfOperationsAA9XTZAmountCSi_SSSitFZ":{"name":"fee(forGasLimit:forgedHexString:numberOfOperations:)","parent_name":"FeeEstimatorService"},"Classes/FeeEstimatorService.html#/s:14KukaiCoreSwift19FeeEstimatorServiceC20addGasSafetyMarginTo7gasUsedS2i_tFZ":{"name":"addGasSafetyMarginTo(gasUsed:)","parent_name":"FeeEstimatorService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC6sharedACvpZ":{"name":"shared","abstract":"

Shared instance so that it can hold onto an event closure

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC17errorEventClosureyAA0aD0VcSgvp":{"name":"errorEventClosure","abstract":"

Called everytime an error is parsed. Extremely useful to track / log errors globally, in order to run logic or record to external service

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC013fromOperationD0_6andLogAA0aD0VAA0h22ResponseInternalResultD0V_SbtFZ":{"name":"fromOperationError(_:andLog:)","abstract":"

Convert an OperationResponseInternalResultError into a KukaiError and optionally log it to the central logger

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC32searchOperationResponseForErrors_6andLogAA0aD0VSgAA0hI0V_SbtFZ":{"name":"searchOperationResponseForErrors(_:andLog:)","abstract":"

Search an OperationResponse to see does it contain any errors, if so return the last one as a KukaiError and optionally log it to the central logger

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC32searchOperationResponseForErrors_6andLogAA0aD0VSgSayAA0hI0VG_SbtFZ":{"name":"searchOperationResponseForErrors(_:andLog:)","abstract":"

Search an [OperationResponse] to see does it contain any errors, if so return the last one as aKukaiError and optionally log it to the central logger

","parent_name":"ErrorHandlingService"},"Classes/ErrorHandlingService.html#/s:14KukaiCoreSwift20ErrorHandlingServiceC015searchForSystemD04data8response07networkD010requestURL0M4Data6andLogAA0aD0VSg10Foundation0O0VSg_So13NSURLResponseCSgs0D0_pSgAN0N0VAQSbtFZ":{"name":"searchForSystemError(data:response:networkError:requestURL:requestData:andLog:)","abstract":"

Take in network response data and see does it contain an error, if so return create aKukaiErrorfrom it and optionally log it to the central logger

","parent_name":"ErrorHandlingService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC5write4data10toFileName20isExcludedFromBackupSb10Foundation4DataV_SSSbtFZ":{"name":"write(data:toFileName:isExcludedFromBackup:)","abstract":"

Write an instance of Data to a given fileName

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC5write9encodable10toFileName20isExcludedFromBackupSbx_SSSbtSERzlFZ":{"name":"write(encodable:toFileName:isExcludedFromBackup:)","abstract":"

Write an instance of an object conforming to Encodable to a fileName

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC8readData12fromFileName10Foundation0G0VSgSS_tFZ":{"name":"readData(fromFileName:)","abstract":"

Read a fileName and return the contents as Data

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC4read4type12fromFileNamexSgxm_SStSeRzlFZ":{"name":"read(type:fromFileName:)","abstract":"

Read a fileName, and parse the contents as an instance of a Decodable object

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC6delete8fileNameSbSS_tFZ":{"name":"delete(fileName:)","abstract":"

Delete a fileName

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC6delete9fileNamesSbSaySSG_tFZ":{"name":"delete(fileNames:)","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC18documentsDirectory20isExcludedFromBackup10Foundation3URLVSgSb_tFZ":{"name":"documentsDirectory(isExcludedFromBackup:)","abstract":"

Get the URL to the devices documents directory, if possible

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC6exists8fileName10Foundation3URLVSgSS_tFZ":{"name":"exists(fileName:)","abstract":"

Check if a fileName exists in the documents directory or not

","parent_name":"DiskService"},"Classes/DiskService.html#/s:14KukaiCoreSwift11DiskServiceC16allFileNamesWith6prefixSaySSGSS_tFZ":{"name":"allFileNamesWith(prefix:)","abstract":"

Find all files in documents directory begining with prefix

","parent_name":"DiskService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC6sharedACvpZ":{"name":"shared","abstract":"

Public shared instace to avoid having multiple copies of the underlying JSContext created

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC19calculateXtzToToken03xtzI4Sell0K4Pool05tokenM011maxSlippage3dexAA0d4SwapE6ResultVSgAA9XTZAmountC_AnA0J6AmountCSdAA18DipDupExchangeNameOtF":{"name":"calculateXtzToToken(xtzToSell:xtzPool:tokenPool:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for a xtzToToken exchange, to perform the operation and display the info to the user in a confirmation screen.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC19calculateTokenToXTZ05tokenI4Sell7xtzPool0kN011maxSlippage3dexAA0d4SwapE6ResultVSgAA0H6AmountC_AA9XTZAmountCANSdAA18DipDupExchangeNameOtF":{"name":"calculateTokenToXTZ(tokenToSell:xtzPool:tokenPool:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for a tokenToXtz exchange, to perform the operation and display the info to the user in a confirmation screen.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC21calculateAddLiquidity3xtz0J4Pool05tokenK005totalI011maxSlippage3dexAA0dhE6ResultVSgAA9XTZAmountC_AoA11TokenAmountCAQSdAA18DipDupExchangeNameOtF":{"name":"calculateAddLiquidity(xtz:xtzPool:tokenPool:totalLiquidity:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for adding liquidity, with an XTZ input

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC21calculateAddLiquidity5token7xtzPool0jL005totalI011maxSlippage3dexAA0dhE6ResultVSgAA11TokenAmountC_AA9XTZAmountCA2OSdAA18DipDupExchangeNameOtF":{"name":"calculateAddLiquidity(token:xtzPool:tokenPool:totalLiquidity:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for adding liquidity, with an Token input

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC24calculateRemoveLiquidity15liquidityBurned05totalI07xtzPool05tokenN011maxSlippage3dexAA0dhE6ResultVSgAA11TokenAmountC_AoA9XTZAmountCAOSdAA18DipDupExchangeNameOtF":{"name":"calculateRemoveLiquidity(liquidityBurned:totalLiquidity:xtzPool:tokenPool:maxSlippage:dex:)","abstract":"

A helper function to create all the necessary calculations for removing liquidity, to return everything the user will get out

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC8settings03forD0Sd3fee_Sd4burnSb14includeSubsidytAA18DipDupExchangeNameO_tFZ":{"name":"settings(forDex:)","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC24xtzToTokenExpectedReturn0gH4Sell0G4Pool05tokenM03dexAA0I6AmountCSgAA9XTZAmountC_AmjA18DipDupExchangeNameOtF":{"name":"xtzToTokenExpectedReturn(xtzToSell:xtzPool:tokenPool:dex:)","abstract":"

The TokenAmount expected to be returned for the supplied XTZAmount, given the dex contract xtzPool and tokenPool.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC23xtzToTokenMinimumReturn11tokenAmount8slippageAA0iM0CSgAH_SdtF":{"name":"xtzToTokenMinimumReturn(tokenAmount:slippage:)","abstract":"

The minimum possible TokenAmount returned, taking into account slippage.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC24xtzToTokenRequiredXtzFor11tokenAmount0G4Pool0mO03dexAA9XTZAmountCSgAA0iN0C_AjmA18DipDupExchangeNameOtF":{"name":"xtzToTokenRequiredXtzFor(tokenAmount:xtzPool:tokenPool:dex:)","abstract":"

Calculate the XTZAmount required in order to receive the supplied TokenAmount.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC22xtzToTokenExchangeRate0gH4Sell0G4Pool05tokenM03dexSo9NSDecimalaSgAA9XTZAmountC_AmA0I6AmountCAA06DipDupJ4NameOtF":{"name":"xtzToTokenExchangeRate(xtzToSell:xtzPool:tokenPool:dex:)","abstract":"

The exchange rate for a given trade, taking into account slippage and fees

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC29xtzToTokenExchangeRateDisplay0gH4Sell0G4Pool05tokenN03dexSo9NSDecimalaSgAA9XTZAmountC_AmA0I6AmountCAA06DipDupJ4NameOtF":{"name":"xtzToTokenExchangeRateDisplay(xtzToSell:xtzPool:tokenPool:dex:)","abstract":"

The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC20xtzToTokenMarketRate0G4Pool05tokenL0So9NSDecimalaSgAA9XTZAmountC_AA0I6AmountCtF":{"name":"xtzToTokenMarketRate(xtzPool:tokenPool:)","abstract":"

Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC21xtzToTokenPriceImpact0gH4Sell0G4Pool05tokenM03dexSo9NSDecimalaSgAA9XTZAmountC_AmA0I6AmountCAA18DipDupExchangeNameOtF":{"name":"xtzToTokenPriceImpact(xtzToSell:xtzPool:tokenPool:dex:)","abstract":"

Calcualte the percentage the price impact the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC24tokenToXtzExpectedReturn0gH4Sell7xtzPool0gN03dexAA9XTZAmountCSgAA11TokenAmountC_AjmA18DipDupExchangeNameOtF":{"name":"tokenToXtzExpectedReturn(tokenToSell:xtzPool:tokenPool:dex:)","abstract":"

The XTZAmount expected to be returned for the supplied TokenAmount, given the dex contracts xtzPool and tokenPool.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC23tokenToXtzMinimumReturn9xtzAmount8slippageAA9XTZAmountCSgAH_SdtF":{"name":"tokenToXtzMinimumReturn(xtzAmount:slippage:)","abstract":"

The minimum possible XTZAmount returned, taking into account slippage.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC26tokenToXtzRequiredTokenFor9xtzAmount0M4Pool0gO03dexAA0kN0CSgAA9XTZAmountC_AmjA18DipDupExchangeNameOtF":{"name":"tokenToXtzRequiredTokenFor(xtzAmount:xtzPool:tokenPool:dex:)","abstract":"

Calculate the TokenAmount required in order to receive the supplied XTZAmount.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC22tokenToXtzExchangeRate0gH4Sell7xtzPool0gN03dexSo9NSDecimalaSgAA11TokenAmountC_AA9XTZAmountCAmA06DipDupJ4NameOtF":{"name":"tokenToXtzExchangeRate(tokenToSell:xtzPool:tokenPool:dex:)","abstract":"

The exchange rate for a given trade, taking into account slippage and fees

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC29tokenToXtzExchangeRateDisplay0gH4Sell7xtzPool0gO03dexSo9NSDecimalaSgAA11TokenAmountC_AA9XTZAmountCAmA06DipDupJ4NameOtF":{"name":"tokenToXtzExchangeRateDisplay(tokenToSell:xtzPool:tokenPool:dex:)","abstract":"

The exchange rate for a given trade, taking into account slippage and fees, formatted and truncated for easier display in the UI.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC20tokenToXtzMarketRate7xtzPool0gM0So9NSDecimalaSgAA9XTZAmountC_AA11TokenAmountCtF":{"name":"tokenToXtzMarketRate(xtzPool:tokenPool:)","abstract":"

Before a user has entered in an amount to trade, its useful to show them the base exchange rate, ignoring slippage.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC21tokenToXtzPriceImpact0gH4Sell7xtzPool0gN03dexSo9NSDecimalaSgAA11TokenAmountC_AA9XTZAmountCAmA18DipDupExchangeNameOtF":{"name":"tokenToXtzPriceImpact(tokenToSell:xtzPool:tokenPool:dex:)","abstract":"

Calcualte the percentage slippage the given trade would incur. Since this is already taken into account for the other functions, this function returns in the scale of 0 - 100, for display purposes.

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC18addLiquidityReturn12xtzToDeposit0J4Pool05totalH08slippage3dexAA11TokenAmountC8expected_AK7minimumtSgAA9XTZAmountC_ApKSdAA18DipDupExchangeNameOtF":{"name":"addLiquidityReturn(xtzToDeposit:xtzPool:totalLiquidity:slippage:dex:)","abstract":"

Calculate the amount of liquidity tokens a user can expect back for an amount of XTZ and Token

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC25addLiquidityTokenRequired12xtzToDeposit0K4Pool05tokenN03dexAA0I6AmountCSgAA9XTZAmountC_AmjA18DipDupExchangeNameOtF":{"name":"addLiquidityTokenRequired(xtzToDeposit:xtzPool:tokenPool:dex:)","abstract":"

Calculate the amount of Token that is required to send along side your XTZ

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC23addLiquidityXtzRequired14tokenToDeposit7xtzPool0kO03dexAA9XTZAmountCSgAA11TokenAmountC_AjmA18DipDupExchangeNameOtF":{"name":"addLiquidityXtzRequired(tokenToDeposit:xtzPool:tokenPool:dex:)","abstract":"

Calculate the amount of XTZ that is required to send along side your Token

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC28removeLiquidityTokenReceived15liquidityBurned05totalH09tokenPool8slippageAA0I6AmountC8expected_AJ7minimumtSgAJ_A2JSdtF":{"name":"removeLiquidityTokenReceived(liquidityBurned:totalLiquidity:tokenPool:slippage:)","abstract":"

Calculate the amount of token a user would revice back if they burned X liquidity

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC26removeLiquidityXtzReceived15liquidityBurned05totalH07xtzPool8slippage3dexAA9XTZAmountC8expected_AK7minimumtSgAA11TokenAmountC_ApKSdAA18DipDupExchangeNameOtF":{"name":"removeLiquidityXtzReceived(liquidityBurned:totalLiquidity:xtzPool:slippage:dex:)","abstract":"

Calculate the amount of XTZ a user would revice back if they burned X liquidity

","parent_name":"DexCalculationService"},"Classes/DexCalculationService.html#/s:14KukaiCoreSwift21DexCalculationServiceC26estimateLiquidityBakingAPY7xtzPoolSo9NSDecimalaSgAA9XTZAmountC_tF":{"name":"estimateLiquidityBakingAPY(xtzPool:)","abstract":"

Estimate the APY of liquidity baking contract, as it has a known income.

","parent_name":"DexCalculationService"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV10FEE_FACTORSivpZ":{"name":"FEE_FACTOR","abstract":"

Constant pulled from: https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV11VETO_PERIODSo9NSDecimalavpZ":{"name":"VETO_PERIOD","abstract":"

Constant pulled from: https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV13VOTING_PERIODSo9NSDecimalavpZ":{"name":"VOTING_PERIOD","abstract":"

Constant pulled from:https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV20ACCURANCY_MULTIPLIERSo9NSDecimalavpZ":{"name":"ACCURANCY_MULTIPLIER","abstract":"

Constant pulled from: https://github.com/madfish-solutions/quipuswap-sdk/blob/4c38ce4a44d7c15da197ecb28e6521f3ac8ff527/src/defaults.ts

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV17getPendingRewards12fromExchange10forAddress10tzKTClient10completionySS_SSAA02TzP0Cys6ResultOyAA9XTZAmountCAA0A5ErrorVGctFZ":{"name":"getPendingRewards(fromExchange:forAddress:tzKTClient:completion:)","abstract":"

Use TzKTClient’s methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV17getPendingRewards12fromExchange10forAddress10tzKTClient7Combine6FutureCySS8exchange_AA9XTZAmountC7rewardstAA0A5ErrorVGSS_SSAA02TzP0CtFZ":{"name":"getPendingRewards(fromExchange:forAddress:tzKTClient:)","abstract":"

Wrapper around getPendingRewards(..., completion: ) to make it easier to create bulk queries, through combine

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html#/s:14KukaiCoreSwift17DAppHelperServiceC9QuipuswapV21getBulkPendingRewards13fromExchanges10forAddress10tzKTClient10completionySaySSG_SSAA02TzQ0Cys6ResultOySaySS8exchange_AA9XTZAmountC7rewardstGAA0A5ErrorVGctFZ":{"name":"getBulkPendingRewards(fromExchanges:forAddress:tzKTClient:completion:)","abstract":"

Use TzKTClient’s methods of storage and bigmap queries, to extract any recorded pending rewards the user might be due, for providing liquidity to a pool

","parent_name":"Quipuswap"},"Classes/DAppHelperService/Quipuswap.html":{"name":"Quipuswap","abstract":"

All functions related to Quipuswap

","parent_name":"DAppHelperService"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC13fromRpcAmountACSgSS_tcfc":{"name":"init(fromRpcAmount:)","abstract":"

Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC13fromRpcAmountACSgSo9NSDecimala_tcfc":{"name":"init(fromRpcAmount:)","abstract":"

Set the internal balance, using a decimal version of an RPC amount. e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC20fromNormalisedAmountACSo9NSDecimala_tcfc":{"name":"init(fromNormalisedAmount:)","abstract":"

Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC20fromNormalisedAmount13decimalPlacesACSgSS_Sitcfc":{"name":"init(fromNormalisedAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC4zeroACyFZ":{"name":"zero()","abstract":"

Quickly create a XTZAmount with zero balance.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info.","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC1poiyA2C_ACtFZ":{"name":"+(_:_:)","abstract":"

Overload + operator to allow users to add two Token amounts of the same type, together.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC2peoiyyACz_ACtFZ":{"name":"+=(_:_:)","abstract":"

Overload += operator to allow users to add two Token amounts of the same type, together in place.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC1soiyA2C_ACtFZ":{"name":"-(_:_:)","abstract":"

Overload - operator to allow users to subtract two Token amounts of the same type.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC2seoiyyACz_ACtFZ":{"name":"-=(_:_:)","abstract":"

Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC1moiySo9NSDecimalaAC_AFtFZ":{"name":"*(_:_:)","abstract":"

Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

","parent_name":"XTZAmount"},"Classes/XTZAmount.html#/s:14KukaiCoreSwift9XTZAmountC1moiyA2C_SitFZ":{"name":"*(_:_:)","abstract":"

Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

","parent_name":"XTZAmount"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC12authProviderAA0d4AuthG0Ovp":{"name":"authProvider","abstract":"

The type of service used to generate the provide key

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC14socialUsernameSSSgvp":{"name":"socialUsername","abstract":"

The raw social media username displayed on the users account. In the case of Twitter, it will not be prefix with an @

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC12socialUserIdSSSgvp":{"name":"socialUserId","abstract":"

The unique id the social media platform has assigned to the users account. Used for querying account details

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC23socialProfilePictureURL10Foundation0I0VSgvp":{"name":"socialProfilePictureURL","abstract":"

A URL to the users profile picture on the given social meida platform

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC12authProvider8username6userId14profilePicture15torusPrivateKeyACSgAA0d4AuthG0O_SSSgA2LSStcfc":{"name":"init(authProvider:username:userId:profilePicture:torusPrivateKey:)","abstract":"

Create an instace of the wallet from the data provided by the Torus network, using TorusAuthService

","parent_name":"TorusWallet"},"Classes/TorusWallet.html#/s:14KukaiCoreSwift11TorusWalletC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Encodable encode func

","parent_name":"TorusWallet"},"Classes/TokenAmount/TokenAmountError.html#/s:14KukaiCoreSwift11TokenAmountC0dE5ErrorO20invalidStringFromRPCyA2EmF":{"name":"invalidStringFromRPC","parent_name":"TokenAmountError"},"Classes/TokenAmount/TokenAmountError.html":{"name":"TokenAmountError","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"

The number of decimal places that this token supports.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC17rpcRepresentationSSvp":{"name":"rpcRepresentation","abstract":"

Format the internal value to ensure it matches the format the RPC will expect

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC24normalisedRepresentationSSvp":{"name":"normalisedRepresentation","abstract":"

Basic formatting of a token to be human readable. For more advanced options, use the format function

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC07fromRpcE013decimalPlacesACSgSS_Sitcfc":{"name":"init(fromRpcAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a RPC string (most likely directly from the RPC node response). e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC07fromRpcE013decimalPlacesACSgSo9NSDecimala_Sitcfc":{"name":"init(fromRpcAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a decimal version of an RPC amount. e.g. “1 XTZ” to the user = “1000000” to the RPC, as there are no such thing as decimal places on the network

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC014fromNormalisedE013decimalPlacesACSo9NSDecimala_Sitcfc":{"name":"init(fromNormalisedAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a decimal version of a normalised amount. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC014fromNormalisedE013decimalPlacesACSgSS_Sitcfc":{"name":"init(fromNormalisedAmount:decimalPlaces:)","abstract":"

Set the internal balance, using a normalised amount string. e.g. if the amount is 1.5 and the token is xtz, internally it will be stored as 1500000

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC4zeroACyFZ":{"name":"zero()","abstract":"

Quickly create a TokenAmount with zero balance and no decimal places.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC11zeroBalance13decimalPlacesACSi_tFZ":{"name":"zeroBalance(decimalPlaces:)","abstract":"

Quickly create a TokenAmount with zero balance.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Token Amounts need an amount and to know the number of decimal places. When downloading from an API, the balance may be presented without the decimal info, where as when we encode, we have the info.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:SE6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC30formatNormalisedRepresentation6localeSSSg10Foundation6LocaleV_tF":{"name":"formatNormalisedRepresentation(locale:)","abstract":"

Format the current value into a human readable string, using the given locale.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC12toRpcDecimalSo9NSDecimalaSgyF":{"name":"toRpcDecimal()","abstract":"

Function to convert the underlying rpc value into a Decimal which can be useful in some situations for integrating with other tools and frameworks.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC19toNormalisedDecimalSo9NSDecimalaSgyF":{"name":"toNormalisedDecimal()","abstract":"

Function to convert the underlying normalised value into a Decimal which can be useful in some situations for integrating with other tools and frameworks.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC11toXTZAmountAA0G0CyF":{"name":"toXTZAmount()","abstract":"

Currently we are unable to cast directly from TokenAmount to XTZAmount. This function will create a new XTZAmount object from the TokenAmount.","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1poiyA2C_ACtFZ":{"name":"+(_:_:)","abstract":"

Overload + operator to allow users to add two Token amounts of the same type, together.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC2peoiyyACz_ACtFZ":{"name":"+=(_:_:)","abstract":"

Overload += operator to allow users to add two Token amounts of the same type, together in place.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1soiyA2C_ACtFZ":{"name":"-(_:_:)","abstract":"

Overload - operator to allow users to subtract two Token amounts of the same type.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC2seoiyyACz_ACtFZ":{"name":"-=(_:_:)","abstract":"

Overload -= operator to allow users to subtract one Token amount of the same type from another, together in place.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1moiySo9NSDecimalaAC_AFtFZ":{"name":"*(_:_:)","abstract":"

Overload multiplcation operator to allow users to multiple a token by a dollar value, and return the localCurrency value of the token.

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1moiyA2C_SitFZ":{"name":"*(_:_:)","abstract":"

Overload multiplcation operator to allow users to multiple a token by an Int. Useful for fee caluclation

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC1loiySbAC_ACtFZ":{"name":"<(_:_:)","abstract":"

Conforming to Comparable

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC11descriptionSSvp":{"name":"description","abstract":"

Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

","parent_name":"TokenAmount"},"Classes/TokenAmount.html#/s:14KukaiCoreSwift11TokenAmountC4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"TokenAmount"},"Classes/Token/TokenType.html#/s:14KukaiCoreSwift5TokenC0D4TypeO3xtzyA2EmF":{"name":"xtz","parent_name":"TokenType"},"Classes/Token/TokenType.html#/s:14KukaiCoreSwift5TokenC0D4TypeO8fungibleyA2EmF":{"name":"fungible","parent_name":"TokenType"},"Classes/Token/TokenType.html#/s:14KukaiCoreSwift5TokenC0D4TypeO11nonfungibleyA2EmF":{"name":"nonfungible","parent_name":"TokenType"},"Classes/Token/TokenType.html":{"name":"TokenType","abstract":"

An Enum to express the type of a token. Different processes are needed to fetch a balance for a users XTZ wallet,","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4nameSSSgvp":{"name":"name","abstract":"

The long name of a token. e.g. “Tezos”.

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC6symbolSSvp":{"name":"symbol","abstract":"

The short name or the symbol of a token. e.g. “XTZ”.

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC9tokenTypeAC0dF0Ovp":{"name":"tokenType","abstract":"

The type of this token. e.g. xtz, fungible, nonfungible

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC9faVersionAA02FaF0OSgvp":{"name":"faVersion","abstract":"

The FaVersion of the token contract, nil for XTZ

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC7balanceAA0D6AmountCvp":{"name":"balance","abstract":"

Object that holds and formats the balance of the token

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"

Get the underlying number of decimal places that this token represents

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC12thumbnailURL10Foundation0F0VSgvp":{"name":"thumbnailURL","abstract":"

The URL to a cached version of the asset (data that we add later on through other service calls)

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC17localCurrencyRateSo9NSDecimalavp":{"name":"localCurrencyRate","abstract":"

The current local currency rate of this token. Used to show the user the net worth of their holdings.

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC20tokenContractAddressSSSgvp":{"name":"tokenContractAddress","abstract":"

In the case of FA1.2 or higher, we need to know the KT1 address for the token so we can fetch balances and make trades. (should be empty for xtz).

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC7tokenIdSo9NSDecimalaSgvp":{"name":"tokenId","abstract":"

Each token type on a contract will have a unique token_id

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC8isHiddenSbvp":{"name":"isHidden","abstract":"

Recording if the user has marked the token as hidden

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC18favouriteSortIndexSiSgvp":{"name":"favouriteSortIndex","abstract":"

Recording if the position the index the user chose for the favourite token to appear

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4nftsSayAA3NFTVGSgvp":{"name":"nfts","abstract":"

The individual NFT’s owned of this token type

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC11mintingToolSSSgvp":{"name":"mintingTool","abstract":"

The URL of the tool used to mint the item

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC11isFavouriteSbvp":{"name":"isFavourite","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4name6symbol9tokenType9faVersion7balance12thumbnailURL0G15ContractAddress0G2Id4nfts11mintingToolACSSSg_SSAC0dH0OAA02FaJ0OSgAA0D6AmountC10Foundation0M0VSgANSo9NSDecimalaSgSayAA3NFTVGSgANtcfc":{"name":"init(name:symbol:tokenType:faVersion:balance:thumbnailURL:tokenContractAddress:tokenId:nfts:mintingTool:)","abstract":"

Init a Token object that will hold all the necessary data to interact with the Tezos network, and the Dexter exchange

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4from03andD6AmountAcA011TzKTBalanceD0V_AA0dG0Ctcfc":{"name":"init(from:andTokenAmount:)","abstract":"

Init a Token from an object returned by the TzKT API

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4fromAcA17TzKTTokenTransferV_tcfc":{"name":"init(from:)","abstract":"

Init a Token from an object returned by the TzKT API

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC3xtzACyFZ":{"name":"xtz()","abstract":"

Create a Token object with all the settings needed for XTZ

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC3xtz10withAmountAcA0dG0C_tFZ":{"name":"xtz(withAmount:)","abstract":"

Create a Token object with all the settings needed for XTZ, with an initial amount. Useful for setting fees.

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC11placeholder7fromNFT6amount12thumbnailURLAcA0G0V_AA0D6AmountC10Foundation0J0VSgtFZ":{"name":"placeholder(fromNFT:amount:thumbnailURL:)","abstract":"

Useful for creating placeholders for pending activity items

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC11descriptionSSvp":{"name":"description","abstract":"

Conforming to CustomStringConvertible to print a number, giving the appearence of a numeric type

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC5isXTZSbyF":{"name":"isXTZ()","abstract":"

Helper function to check if the Token instance being passed aroun is pointing to XTZ. As many functions will require different functionality for fa token versus XTZ

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

Conforming to Equatable to enable working with UITableViewDiffableDataSource

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC4hash4intoys6HasherVz_tF":{"name":"hash(into:)","abstract":"

Conforming to Hashable to enable working with UITableViewDiffableDataSource

","parent_name":"Token"},"Classes/Token.html#/s:14KukaiCoreSwift5TokenC2idSSvp":{"name":"id","abstract":"

Conforming to Identifiable to enable working with ForEach and similiar looping functions","parent_name":"Token"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC4typeAA0E4TypeOvp":{"name":"type","abstract":"

enum used to differientate wallet class types. Needed for applications that allow users to create many different types of wallets

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC7addressSSvp":{"name":"address","abstract":"

The TZ1 or TZ2 address of the wallet

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC10privateKey0a6CryptoC007PrivateG0Vvp":{"name":"privateKey","abstract":"

An object representing the PrivateKey used to generate the wallet

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC9publicKey0a6CryptoC006PublicG0Vvp":{"name":"publicKey","abstract":"

An object representing the PublicKey used to generate the wallet address

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC8mnemonic0a6CryptoC08MnemonicVSgvp":{"name":"mnemonic","abstract":"

Optional Bip39 mnemonic used to generate the wallet

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC25secp256k1WithBase58String4typeACSgSS_AA0E4TypeOtcfc":{"name":"init(secp256k1WithBase58String:type:)","abstract":"

Attempt to create an instance of a RegularWallet from an encoded string containing a private key

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC12withMnemonic10passphraseACSg0a6CryptoC00G0V_SStcfc":{"name":"init(withMnemonic:passphrase:)","abstract":"

Create a RegularWallet by supplying a Mnemonic and a passphrase (or “” if none).

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC18withMnemonicLength10passphraseACSg0a6CryptoC00G0V13NumberOfWordsO_SStcfc":{"name":"init(withMnemonicLength:passphrase:)","abstract":"

Create a RegularWallet by asking for a mnemonic of a given number of words and a passphrase (or “” if none).

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC4sign_11isOperation10completionySS_Sbys6ResultOySays5UInt8VGAA0A5ErrorVGctF":{"name":"sign(_:isOperation:completion:)","abstract":"

Sign a hex payload with the private key

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC15privateKeyCurve0a6CryptoC0010EllipticalH0OyF":{"name":"privateKeyCurve()","abstract":"

Return the curve used to create the key

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:14KukaiCoreSwift13RegularWalletC22publicKeyBase58encodedSSyF":{"name":"publicKeyBase58encoded()","abstract":"

Get a Base58 encoded version of the public key, in order to reveal the address on the network

","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"RegularWallet"},"Classes/RegularWallet.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"RegularWallet"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC8endpointSSvp":{"name":"endpoint","abstract":"

The endpoint that will be added onto the TezosNodeConfig.primaryNodeURL to form a full URL for the request

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC7payload10Foundation4DataVSgvp":{"name":"payload","abstract":"

An optional payload for sending HTTP POST requests

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC12responseTypexmvp":{"name":"responseType","abstract":"

The expected response type from the network

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC6isPostSbvp":{"name":"isPost","abstract":"

Computed property to indicate wheter or not this is a POST request

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC8endpoint7payload12responseTypeACyxGSS_10Foundation4DataVSgxmtcfc":{"name":"init(endpoint:payload:responseType:)","abstract":"

Init an RPC object, to be passed to the network layer to performa request to the node.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCC15encodableToData0E010Foundation0G0VSgqd___tSERd__lFZ":{"name":"encodableToData(encodable:)","abstract":"

Helper function to wrap up JSONEncoder().encode and log any errors.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE10xtzBalance10forAddressACySSGSS_tFZ":{"name":"xtzBalance(forAddress:)","abstract":"

Creates an RPC to fetch an XTZ balance for a given Address

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE11getDelegate10forAddressACySSGSS_tFZ":{"name":"getDelegate(forAddress:)","abstract":"

Creates an RPC to fetch a deelgate for a given Address

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE10managerKey10forAddressACySSSgGSS_tFZ":{"name":"managerKey(forAddress:)","abstract":"

Creates an RPC to fetch the managerKey for a given Address

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE7counter10forAddressACySSGSS_tFZ":{"name":"counter(forAddress:)","abstract":"

Creates an RPC to fetch the current counter for a given Address

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE5forge16operationPayloadACySSGSgAA09OperationG0V_tFZ":{"name":"forge(operationPayload:)","abstract":"

Creates an RPC to remotely forge an operation

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASSRszrlE6inject11signedBytesACySSGSgSS_tFZ":{"name":"inject(signedBytes:)","abstract":"

Creates an RPC to inject an operation

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A14BlockchainHeadVRszrlE010blockchainF0ACyAEGyFZ":{"name":"blockchainHead()","abstract":"

Creates an RPC to fetch the HEAD of the blockchain and parse it into an object to extract the pieces we are interested in.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A14BlockchainHeadVRszrlE010blockchainF6Minus3ACyAEGyFZ":{"name":"blockchainHeadMinus3()","abstract":"

Creates an RPC to fetch the HEAD of 3 blocks previous and parse it into an object to extract the pieces we are interested in.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A14NetworkVersionVRszrlE07networkF0ACyAEGyFZ":{"name":"networkVersion()","abstract":"

Creates an RPC to fetch the details about the version of the network running on the given server.

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A16NetworkConstantsVRszrlE07networkF0ACyAEGyFZ":{"name":"networkConstants()","abstract":"

Creates an RPC to fetch the network constants for the given server, such as how much mutez it costs per byte of storage, or the maximum allowed gas amount

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASayAA16OperationPayloadVGRszrlE5parse11hashToParse8metadataACyAFGSgSS_AA0E8MetadataVtFZ":{"name":"parse(hashToParse:metadata:)","abstract":"

Creates an RPC to remotely parse an operation to verify its contents. Function takes in a hash, as it is returned from the forge call. This function will do all the necessary parsing and formatting

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAASayAA17OperationResponseVGRszrlE8preapply16operationPayloadACyAFGSgAA0eI0V_tFZ":{"name":"preapply(operationPayload:)","abstract":"

Creates an RPC to preapply an operation. This OperationPayload must have had its signature and protocol set

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCA2A17OperationResponseVRszrlE03runE00gE7PayloadACyAEGSgAA03RuneH0V_tFZ":{"name":"runOperation(runOperationPayload:)","abstract":"

Creates an RPC to estimate an operation

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAA10Foundation4DataVRszrlE15contractStorage0G7AddressACyAFGSS_tFZ":{"name":"contractStorage(contractAddress:)","abstract":"

Creates an RPC to fetch a contracts Michelson storage

","parent_name":"RPC"},"Classes/RPC.html#/s:14KukaiCoreSwift3RPCCAA10Foundation4DataVRszrlE6bigMap2idACyAFGSS_tFZ":{"name":"bigMap(id:)","abstract":"

Creates an RPC to fetch the contents of the given big map

","parent_name":"RPC"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC6amountSSvp":{"name":"amount","abstract":"

The amount of XTZ to send. Use TokenAmount().rpcRepresentation to create this value

","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC11destinationSSvp":{"name":"destination","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC10parametersSDySSypGSgvp":{"name":"parameters","abstract":"

Dictionary holding the entrypoint and value of the contract call

","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC6amount6source11destinationAcA11TokenAmountC_S2Stcfc":{"name":"init(amount:source:destination:)","abstract":"

Create an OperationTransaction, to send an amount of token to a destination

","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC6amount6source11destination10parametersAcA11TokenAmountC_S2SSDySSypGtcfc":{"name":"init(amount:source:destination:parameters:)","abstract":"

Create an OperationTransaction, to invoke a smart contract call

","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationTransaction"},"Classes/OperationTransaction.html#/s:14KukaiCoreSwift20OperationTransactionC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationTransaction"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC5levelSivp":{"name":"level","abstract":"

Block level

","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC5nonceSSvp":{"name":"nonce","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC6wallet5level5nonceAcA6Wallet_p_SiSStcfc":{"name":"init(wallet:level:nonce:)","abstract":"

Init with wallet object, block level, and nonce

","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationSeedNonceRevelation.html#/s:14KukaiCoreSwift28OperationSeedNonceRevelationC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationSeedNonceRevelation"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC9publicKeySSvp":{"name":"publicKey","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC6walletAcA6Wallet_p_tcfc":{"name":"init(wallet:)","abstract":"

Create an OperationReveal.

","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC22base58EncodedPublicKey13walletAddressACSS_SStcfc":{"name":"init(base58EncodedPublicKey:walletAddress:)","abstract":"

Create an OperationReveal.

","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationReveal"},"Classes/OperationReveal.html#/s:14KukaiCoreSwift15OperationRevealC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationReveal"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC6periodSivp":{"name":"period","abstract":"

The voting period

","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC9proposalsSaySSGvp":{"name":"proposals","abstract":"

List of proposal identifiers

","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC6wallet6period9proposalsAcA6Wallet_p_SiSaySSGtcfc":{"name":"init(wallet:period:proposals:)","abstract":"

Init with wallet, voting period and list of proposal identifiers

","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationProposals"},"Classes/OperationProposals.html#/s:14KukaiCoreSwift18OperationProposalsC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationProposals"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC7balanceSSvp":{"name":"balance","abstract":"

The initial balance to give to the contract

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC6scriptSDyS2SGvp":{"name":"script","abstract":"

Dictionary holding the code and storage of the contract to create.

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC6source7balance4code7storageACSS_AA9XTZAmountCS2Stcfc":{"name":"init(source:balance:code:storage:)","abstract":"

Create an OperationOrigination.

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationOrigination"},"Classes/OperationOrigination.html#/s:14KukaiCoreSwift20OperationOriginationC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationOrigination"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC5levelSivp":{"name":"level","abstract":"

Block level

","parent_name":"OperationEndorsement"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC6wallet5levelAcA6Wallet_p_Sitcfc":{"name":"init(wallet:level:)","abstract":"

Init with wallet and block level

","parent_name":"OperationEndorsement"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationEndorsement"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationEndorsement"},"Classes/OperationEndorsement.html#/s:14KukaiCoreSwift20OperationEndorsementC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V7ContentV4kindAA0D4KindOvp":{"name":"kind","parent_name":"Content"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V7ContentV5levelSivp":{"name":"level","parent_name":"Content"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V6branchSSvp":{"name":"branch","parent_name":"InlinedEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V10operationsAE7ContentVvp":{"name":"operations","parent_name":"InlinedEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC07InlinedF0V9signatureSSSgvp":{"name":"signature","parent_name":"InlinedEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement/Content.html":{"name":"Content","parent_name":"InlinedEndorsement"},"Classes/OperationDoubleEndorsementEvidence/InlinedEndorsement.html":{"name":"InlinedEndorsement","abstract":"

Internal struct used to amtch expected struct of data

","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC3op1AC07InlinedF0Vvp":{"name":"op1","abstract":"

The first endorsement

","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC3op2AC07InlinedF0Vvp":{"name":"op2","abstract":"

The second endorsement (should be matching details of first)

","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC6wallet3op13op2AcA6Wallet_p_AC07InlinedF0VAItcfc":{"name":"init(wallet:op1:op2:)","abstract":"

Init with wallet and 2 suspected endorsements

","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleEndorsementEvidence.html#/s:14KukaiCoreSwift34OperationDoubleEndorsementEvidenceC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationDoubleEndorsementEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC3bh1AA0D11BlockHeaderVvp":{"name":"bh1","abstract":"

The block header of the first baked block

","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC3bh2AA0D11BlockHeaderVvp":{"name":"bh2","abstract":"

The block header of the second baked block

","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC6wallet3bh13bh2AcA6Wallet_p_AA0D11BlockHeaderVAItcfc":{"name":"init(wallet:bh1:bh2:)","abstract":"

Init with wallet and two block headers

","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDoubleBakingEvidence.html#/s:14KukaiCoreSwift29OperationDoubleBakingEvidenceC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationDoubleBakingEvidence"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC8delegateSSSgvp":{"name":"delegate","abstract":"

The baker to delegate too, or nil to undelegate

","parent_name":"OperationDelegation"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC6source8delegateACSS_SSSgtcfc":{"name":"init(source:delegate:)","abstract":"

Create an OperationDelegation.

","parent_name":"OperationDelegation"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationDelegation"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationDelegation"},"Classes/OperationDelegation.html#/s:14KukaiCoreSwift19OperationDelegationC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationDelegation"},"Classes/OperationBallot/Ballot.html#/s:14KukaiCoreSwift15OperationBallotC0E0O3nayyA2EmF":{"name":"nay","parent_name":"Ballot"},"Classes/OperationBallot/Ballot.html#/s:14KukaiCoreSwift15OperationBallotC0E0O3yayyA2EmF":{"name":"yay","parent_name":"Ballot"},"Classes/OperationBallot/Ballot.html#/s:14KukaiCoreSwift15OperationBallotC0E0O4passyA2EmF":{"name":"pass","parent_name":"Ballot"},"Classes/OperationBallot/Ballot.html":{"name":"Ballot","abstract":"

Enum matching the available ballot options

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC6periodSivp":{"name":"period","abstract":"

The voting period

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC8proposalSSvp":{"name":"proposal","abstract":"

The identifier of the proposa;

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC6ballotAC0E0Ovp":{"name":"ballot","abstract":"

The wallet holders vote

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC6wallet6period8proposal6ballotAcA6Wallet_p_SiSSAC0E0Otcfc":{"name":"init(wallet:period:proposal:ballot:)","abstract":"

Init with wallet, period, proposal and ballot

","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","parent_name":"OperationBallot"},"Classes/OperationBallot.html#/s:14KukaiCoreSwift15OperationBallotC7isEqualySbACF":{"name":"isEqual(_:)","parent_name":"OperationBallot"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC9publicKeySSvp":{"name":"publicKey","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC6secretSSvp":{"name":"secret","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC6wallet9andSecretAcA6Wallet_p_SStcfc":{"name":"init(wallet:andSecret:)","abstract":"

Create an OperationActivateAccount.

","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"OperationActivateAccount"},"Classes/OperationActivateAccount.html#/s:14KukaiCoreSwift24OperationActivateAccountC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"OperationActivateAccount"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC13operationKindAA0dF0Ovp":{"name":"operationKind","abstract":"

An enum to denote the type of operation. e.g. transaction, delegation, reveal etc.

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC6sourceSSSgvp":{"name":"source","abstract":"

The source address for the operation

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC7counterSSSgvp":{"name":"counter","abstract":"

A string representing a numeric counter. Must be unique and 1 higher than the previous counter. Current counter obtained from the metadata query in TezosNodeClient

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC13operationFeesAA0dF0Vvp":{"name":"operationFees","abstract":"

Object representing the various fees, storage and compute required to fulfil this operation

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC13operationKind6sourceAcA0dF0O_SStcfc":{"name":"init(operationKind:source:)","abstract":"

Create a base operation.

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC4fromACs7Decoder_p_tKcfc":{"name":"init(from:)","abstract":"

Create a base operation.

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC6encode2toys7Encoder_p_tKF":{"name":"encode(to:)","abstract":"

Convert the object into a data format, such as JSON.

","parent_name":"Operation"},"Classes/Operation.html#/s:14KukaiCoreSwift9OperationC7isEqualySbACF":{"name":"isEqual(_:)","abstract":"

A function to check if two operations are equal.

","parent_name":"Operation"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC4typeAA0E4TypeOvp":{"name":"type","abstract":"

The wallet type, hardcoded to always be WalletType.ledger

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC7addressSSvp":{"name":"address","abstract":"

The TZ address pulled from the Ledger device, cached to avoid complex retrieval when fetching balances etc.

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC9publicKeySSvp":{"name":"publicKey","abstract":"

The raw hex public key extracted from the Ledger, needed in order to perform REVEAL operations

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC14derivationPathSSvp":{"name":"derivationPath","abstract":"

The derivation path used to fetch the address and public key

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC5curve0a6CryptoC015EllipticalCurveOvp":{"name":"curve","abstract":"

The elliptical curve used to fetch the address and public key

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC10ledgerUUIDSSvp":{"name":"ledgerUUID","abstract":"

The unique ledger UUID, that corresponds to this wallet address

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC7address9publicKey14derivationPath5curve10ledgerUUIDACSgSS_S2S0a6CryptoC015EllipticalCurveOSStcfc":{"name":"init(address:publicKey:derivationPath:curve:ledgerUUID:)","abstract":"

Create an instance of a LedgerWallet. Can return nil if invalid public key supplied

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC4sign_11isOperation10completionySS_Sbys6ResultOySays5UInt8VGAA0A5ErrorVGctF":{"name":"sign(_:isOperation:completion:)","abstract":"

Sign a hex string.","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC15privateKeyCurve0a6CryptoC0010EllipticalH0OyF":{"name":"privateKeyCurve()","abstract":"

Function to extract the curve used to create the public key

","parent_name":"LedgerWallet"},"Classes/LedgerWallet.html#/s:14KukaiCoreSwift12LedgerWalletC22publicKeyBase58encodedSSyF":{"name":"publicKeyBase58encoded()","abstract":"

Function to convert the public key into a Base58 encoded string

","parent_name":"LedgerWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC4typeAA10WalletTypeOvp":{"name":"type","abstract":"

The underlying wallet type, set to .hd

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC7addressSSvp":{"name":"address","abstract":"

The public TZ1 address of the wallet

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC10privateKey0a6CryptoC007PrivateF0Vvp":{"name":"privateKey","abstract":"

An WalletCore object representing the PrivateKey used to generate the wallet

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC9publicKey0a6CryptoC006PublicF0Vvp":{"name":"publicKey","abstract":"

An WalletCore object representing the PublicKey used to generate the wallet address

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC8mnemonic0a6CryptoC08MnemonicVvp":{"name":"mnemonic","abstract":"

The Bip39 mnemonic used to generate the wallet

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC14derivationPathSSvp":{"name":"derivationPath","abstract":"

The Bip44 derivationPath used to create the wallet

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC12withMnemonic10passphrase14derivationPathACSg0a6CryptoC00F0V_S2Stcfc":{"name":"init(withMnemonic:passphrase:derivationPath:)","abstract":"

Create a HDWallet by supplying a mnemonic string and a passphrase (or “” if none).

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC18withMnemonicLength10passphrase14derivationPathACSg0a6CryptoC00F0V13NumberOfWordsO_S2Stcfc":{"name":"init(withMnemonicLength:passphrase:derivationPath:)","abstract":"

Create a HDWallet by asking for a mnemonic of a given number of words and a passphrase (or “” if none).

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC4sign_11isOperation10completionySS_Sbys6ResultOySays5UInt8VGAA0A5ErrorVGctF":{"name":"sign(_:isOperation:completion:)","abstract":"

Sign a hex payload with the private key

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC15privateKeyCurve0a6CryptoC0010EllipticalG0OyF":{"name":"privateKeyCurve()","abstract":"

Return the curve used to create the key

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC22publicKeyBase58encodedSSyF":{"name":"publicKeyBase58encoded()","abstract":"

Get a Base58 encoded version of the public key, in order to reveal the address on the network

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC11createChild12accountIndexACSgSi_tF":{"name":"createChild(accountIndex:)","abstract":"

The default implementation in Ledger is to not give users the option to provide their own derivation path, but instead increment the “account” field by 1 each time.","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:14KukaiCoreSwift8HDWalletC11createChild14derivationPathACSgSS_tF":{"name":"createChild(derivationPath:)","abstract":"

This function will create a new HDWallet, by using the same key combined with the supplied derivationPath

","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"HDWallet"},"Classes/HDWallet.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"HDWallet"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC8contractSSvp":{"name":"contract","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC7networkSSvp":{"name":"network","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC8token_idSivp":{"name":"token_id","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC6symbolSSSgvp":{"name":"symbol","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC4nameSSSgvp":{"name":"name","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC8decimalsSivp":{"name":"decimals","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC9faVersionAA02FaJ0OSgvp":{"name":"faVersion","parent_name":"BetterCallDevTokenMetadata"},"Classes/BetterCallDevTokenMetadata.html#/s:14KukaiCoreSwift26BetterCallDevTokenMetadataC8imageURL10Foundation0J0VSgvp":{"name":"imageURL","parent_name":"BetterCallDevTokenMetadata"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV33tokenIdAndAmountFromSendMichelson9michelsonSS03rpcJ0_So9NSDecimalaSg0gH0SS11destinationtSgyp_tFZ":{"name":"tokenIdAndAmountFromSendMichelson(michelson:)","abstract":"

Extract rpc amount (without decimal info) a tokenId, and the destination from a michelson FA1.2 / FA2 transfer payload

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV18faTokenDetailsFrom11transactionSS13tokenContract_SS9rpcAmountSo9NSDecimalaSg0L2IdSS11destinationtSgAA0D11TransactionC_tFZ":{"name":"faTokenDetailsFrom(transaction:)","abstract":"

Extract details from a payload in order to present to the user what it is they are trying to send

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV18faTokenDetailsFrom10operationsSS13tokenContract_SS9rpcAmountSo9NSDecimalaSg0L2IdSS11destinationtSgSayAA0D0CG_tFZ":{"name":"faTokenDetailsFrom(operations:)","abstract":"

Helper to call faTokenDetailsFrom(transaction: OperationTransaction) on the first OperationTransaction in an array of operations. Allows to more easily parse an array of operations that may include approval‘s or update_operator calls

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV13isTezTransfer10operationsSbSayAA0D0CG_tFZ":{"name":"isTezTransfer(operations:)","abstract":"

Return true if

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV023firstTransferEntrypointD010operationsAA0D11TransactionCSgSayAA0D0CG_tFZ":{"name":"firstTransferEntrypointOperation(operations:)","abstract":"

Easy way to extract the first non-approval or update_operator transaction

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV14isContractCall10operationsSS10entrypoint_SS7addresstSgSayAA0D0CG_tFZ":{"name":"isContractCall(operations:)","abstract":"

Return the entrypoint and address of the first operation, that doesn’t equal approve, update_operator or transfer

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV017firstContractCallD010operationsAA0D11TransactionCSgSayAA0D0CG_tFZ":{"name":"firstContractCallOperation(operations:)","abstract":"

Return the first operation where entrypoint doesn’t equal approve, update_operator or transfer

","parent_name":"Extractor"},"Classes/OperationFactory/Extractor.html#/s:14KukaiCoreSwift16OperationFactoryC9ExtractorV29totalXTZAmountForContractCall10operationsAA0H0CSayAA0D0CG_tFZ":{"name":"totalXTZAmountForContractCall(operations:)","abstract":"

Run through list of operations and extract .amount from any OperationTransaction

","parent_name":"Extractor"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC04sendD0_2of4from2toSayAA0D0CGAA11TokenAmountC_AA0J0CS2StFZ":{"name":"sendOperation(_:of:from:to:)","abstract":"

Create the operations necessary to send an amount of a token to a destination address.

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC04sendD0_5ofNft4from2toSayAA0D0CGSo9NSDecimala_AA3NFTVS2StFZ":{"name":"sendOperation(_:ofNft:from:to:)","abstract":"

Create the operations necessary to send aan NFT

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC08delegateD02to4fromSayAA0D0CGSS_SStFZ":{"name":"delegateOperation(to:from:)","abstract":"

Create the operations necessary to delegate funds to a baker.

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC010undelegateD07addressSayAA0D0CGSS_tFZ":{"name":"undelegateOperation(address:)","abstract":"

Create the operations necessary to remove the current delegate from an address.

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC14swapXtzToToken7withDex9xtzAmount03miniM013walletAddress7timeoutSayAA0D0CGAA14DipDupExchangeV_AA9XTZAmountCAA0iM0CSSSdtFZ":{"name":"swapXtzToToken(withDex:xtzAmount:minTokenAmount:walletAddress:timeout:)","abstract":"

Create the operations necessary to perform an exchange of XTZ for a given FA token, using a given dex

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC14swapTokenToXTZ7withDex11tokenAmount12minXTZAmount13walletAddress7timeoutSayAA0D0CGAA14DipDupExchangeV_AA0gM0CAA0O0CSSSdtFZ":{"name":"swapTokenToXTZ(withDex:tokenAmount:minXTZAmount:walletAddress:timeout:)","abstract":"

Create the operations necessary to perform an exchange of a given FA token for XTZ, using dex contracts

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC07approveD012tokenAddress07spenderH09allowance06walletH0AA0D0CSS_SSAA11TokenAmountCSStFZ":{"name":"approveOperation(tokenAddress:spenderAddress:allowance:walletAddress:)","abstract":"

Create an operation to call the entrypoint approve, to allow another address to spend some of your token (only FA1.2)","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC015updateOperatorsD012tokenAddress07spenderI09allowance06walletI0AA0D0CSS_SSAA11TokenAmountCSStFZ":{"name":"updateOperatorsOperation(tokenAddress:spenderAddress:allowance:walletAddress:)","abstract":"

Create an operation to call the entrypoint update_operators, to allow another address to spend some of your token (only FA2)","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC09allowanceD08standard12tokenAddress07spenderI00F006walletI0AA0D0CAA19DipDupTokenStandardO_S2SAA0N6AmountCSStFZ":{"name":"allowanceOperation(standard:tokenAddress:spenderAddress:allowance:walletAddress:)","abstract":"

Return the operation necessary to register an allowance (either calling apporve or update_operators) depending on the token standard version. Removing the need to check manually","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC12addLiquidity7withDex3xtz5token11minLiquidty09isInitialG013walletAddress7timeoutSayAA0D0CGAA14DipDupExchangeV_AA9XTZAmountCAA11TokenAmountCATSbSSSdtFZ":{"name":"addLiquidity(withDex:xtz:token:minLiquidty:isInitialLiquidity:walletAddress:timeout:)","abstract":"

Create the operations necessary to add liquidity to a dex contract. Use DexCalculationService to figure out the numbers required

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC15removeLiquidity7withDex6minXTZ0J5Token15liquidityToBurn13walletAddress7timeoutSayAA0D0CGAA14DipDupExchangeV_AA9XTZAmountCAA0L6AmountCASSSSdtFZ":{"name":"removeLiquidity(withDex:minXTZ:minToken:liquidityToBurn:walletAddress:timeout:)","abstract":"

Create the operations necessary to remove liquidity from a dex contract, also withdraw pending rewards if applicable. Use DexCalculationService to figure out the numbers required

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC15withdrawRewards7withDex13walletAddressSayAA0D0CGAA14DipDupExchangeV_SStFZ":{"name":"withdrawRewards(withDex:walletAddress:)","abstract":"

Create the operations necessary to withdraw rewards from a dex contract. For example in quipuswap, XTZ provided as liquidity will earn baking rewards. This can been withdrawn at any time while leaving liquidity in palce

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC16operationPayload12fromMetadata13andOperations13walletAddress22base58EncodedPublicKeyAA0dG0VAA0dI0V_SayAA0D0CGS2StFZ":{"name":"operationPayload(fromMetadata:andOperations:walletAddress:base58EncodedPublicKey:)","abstract":"

Convert an array of operations into the format expected by the RPC. Will also inject a OperationReveal if the sender has not yet revealed their public key.

","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC27createDexterTimestampString19nowPlusTimeIntervalSSSd_tFZ":{"name":"createDexterTimestampString(nowPlusTimeInterval:)","abstract":"

Dexter requires date strings to act as deadline dates for exchanges.","parent_name":"OperationFactory"},"Classes/OperationFactory.html#/s:14KukaiCoreSwift16OperationFactoryC18sendTokenMichelson12forFaVersion11tokenAmount0L2Id2to4fromSDySSypGAA0jK0O_AA0gM0CSo9NSDecimalaS2StFZ":{"name":"sendTokenMichelson(forFaVersion:tokenAmount:tokenId:to:from:)","parent_name":"OperationFactory"},"Classes/OperationFactory/Extractor.html":{"name":"Extractor","abstract":"

Internal Struct to encapsulate helpers methods needed to extract critical information from an array of operations, needed for processing decisions like “do i display a send token screen, or a send NFt screen”, fetching total XTZ sent in 1 action etc

","parent_name":"OperationFactory"},"Classes/TzKTClient/Constants.html#/s:14KukaiCoreSwift10TzKTClientC9ConstantsV21tokenBalanceQuerySizeSivpZ":{"name":"tokenBalanceQuerySize","parent_name":"Constants"},"Classes/TzKTClient/TzKTServiceError.html#/s:14KukaiCoreSwift10TzKTClientC0D14KTServiceErrorO10invalidURLyA2EmF":{"name":"invalidURL","parent_name":"TzKTServiceError"},"Classes/TzKTClient/TzKTServiceError.html#/s:14KukaiCoreSwift10TzKTClientC0D14KTServiceErrorO05parseG0yAESScAEmF":{"name":"parseError(_:)","parent_name":"TzKTServiceError"},"Classes/TzKTClient/TzKTServiceError.html":{"name":"TzKTServiceError","abstract":"

Unique Errors that TzKTClient can throw

","parent_name":"TzKTClient"},"Classes/TzKTClient/Constants.html":{"name":"Constants","abstract":"

Constants needed for interacting with the API

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC11isListeningSbvp":{"name":"isListening","abstract":"

Is currently monitoring an address for update notifications

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC16accountDidChangeSaySSGvp":{"name":"accountDidChange","abstract":"

Notifications of monitored addresses that have changed

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC14networkService6config19betterCallDevClient06dipDupL0AcA07NetworkG0C_AA09TezosNodeL6ConfigVAA06BetterjkL0CAA03DipnL0Ctcfc":{"name":"init(networkService:config:betterCallDevClient:dipDupClient:)","abstract":"

Init a TzKTClient with a NetworkService and a TezosNodeClientConfig and a BetterCallDevClient.

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC10getStorage11forContract6ofType10completionySS_xmys6ResultOyxAA0A5ErrorVGctSeRzSERzlF":{"name":"getStorage(forContract:ofType:completion:)","abstract":"

Get the storage of a given contract and parse it to a supplied model type

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC9getBigMap5forId6ofType10completionySS_xmys6ResultOyxAA0A5ErrorVGctSeRzSERzlF":{"name":"getBigMap(forId:ofType:completion:)","abstract":"

Get the keys of a big map, by ID and parse it to a model

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC12getBigMapKey5forId3key6ofType10completionySS_SSxmys6ResultOyxAA0A5ErrorVGctSeRzSERzlF":{"name":"getBigMapKey(forId:key:ofType:completion:)","abstract":"

Get the keys of a big map, but filtered to only one specific key. Parse the response as the supplied model

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC14suggestAccount9forString10completionySS_ys6ResultOyAA0D9KTAddressVSgAA0A5ErrorVGctF":{"name":"suggestAccount(forString:completion:)","abstract":"

Call https://api.tzkt.io/v1/suggest/accounts/… appending the supplied string, in an attempt to search for an account with a known alias

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC6bakers10completionyys6ResultOySayAA0D7KTBakerVGAA0A5ErrorVGc_tF":{"name":"bakers(completion:)","abstract":"

Call https://api.baking-bad.org/v2/bakers/ for a list of public bakers if on mainnet, else search for all accounts self delegating on testnet

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC11bakerConfig10forAddress10completionySS_ys6ResultOyAA0D7KTBakerVAA0A5ErrorVGctF":{"name":"bakerConfig(forAddress:completion:)","abstract":"

Call https://api.baking-bad.org/v2/bakers/…?configs=true to get the config settings for the given baker

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC16delegatorRewards10forAddress5limit10completionySS_Siys6ResultOySayAA0D17KTDelegatorRewardVGAA0A5ErrorVGctF":{"name":"delegatorRewards(forAddress:limit:completion:)","abstract":"

Call https://api.tzkt.io/v1/rewards/delegators/…?limit=… to get the config settings for the given baker

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC25estimateLastAndNextReward10forAddress8delegate10completionySS_AA0D17KTAccountDelegateVys6ResultOyAA09AggregateJ11InformationVAA0A5ErrorVGctF":{"name":"estimateLastAndNextReward(forAddress:delegate:completion:)","abstract":"

Make many different calls to attempt to figure out the previous reward the user should have received, and the next potential reward

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC13getLastReward10forAddress12uniqueBakers15payoutAddresses10completionySS_SayAA0D9KTAddressVGSDySSAJGys6ResultOySayAA0D13KTTransactionVGAA0A5ErrorVGctF":{"name":"getLastReward(forAddress:uniqueBakers:payoutAddresses:completion:)","abstract":"

Take all the baker addresses and payout addresses and find the last transaction (if any) received from any of them

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC6cycles5limit10completionySi_ys6ResultOySayAA0D7KTCycleVGAA0A5ErrorVGctF":{"name":"cycles(limit:completion:)","abstract":"

Call https://api.tzkt.io/v1/cycles?limit=… to get the 10 most recent cycles

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC13cycleForLevel6cycles5levelAA0D7KTCycleVSgSayAHG_So9NSDecimalatF":{"name":"cycleForLevel(cycles:level:)","abstract":"

Given a list of cycles, search through them to find what cycle a given block level appeared in","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC12getOperation6byHash10completionySS_ySayAA0D11KTOperationVGSg_AA0A5ErrorVSgtctF":{"name":"getOperation(byHash:completion:)","abstract":"

Query details about the given operation

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC23listenForAccountChanges9addresses13withDebuggingySaySSG_SbtF":{"name":"listenForAccountChanges(addresses:withDebugging:)","abstract":"

Open a websocket connection to request a notification for any changes to the given account. The @Published var accountDidChange will be notified if something occurs

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC30stopListeningForAccountChangesyyF":{"name":"stopListeningForAccountChanges()","abstract":"

Close the websocket from listenForAccountChanges

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC31changeAddressToListenForChanges9addressesySaySSG_tF":{"name":"changeAddressToListenForChanges(addresses:)","abstract":"

Close the current connection and open another

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC15getBalanceCount10forAddress10completionySS_ys6ResultOySiAA0A5ErrorVGctF":{"name":"getBalanceCount(forAddress:completion:)","abstract":"

Get the count of tokens the given address has balances for (excluding zero balances)

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC14getBalancePage10forAddress6offset10completionySS_Siys6ResultOySayAA0D9KTBalanceVGAA0A5ErrorVGctF":{"name":"getBalancePage(forAddress:offset:completion:)","abstract":"

Tokens balances and metadata need to be fetch from a paginated API. THis function calls a sinlerequest or 1 page of balances / metadata

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC10getAccount10forAddress10completionySS_ys6ResultOyAA0D9KTAccountVAA0A5ErrorVGctF":{"name":"getAccount(forAddress:completion:)","abstract":"

Get the account object from TzKT caontaining information about the address, its balance and baker

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC14getAllBalances10forAddress10completionySS_ys6ResultOyAA7AccountVAA0A5ErrorVGctF":{"name":"getAllBalances(forAddress:completion:)","abstract":"

Get all balances from one function call, by fetching the result from getBalanceCount and using that to decide how many pages should be called

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC9avatarURL8forToken10Foundation0G0VSgSS_tFZ":{"name":"avatarURL(forToken:)","abstract":"

In order to access the cached images, you need the URL it was downloaded from. This can either be found inside the Token objects returned as part of Account from the fetchAccountInfo func.","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC17fetchTransactions10forAddress5limit10completionySS_SiySayAA0D13KTTransactionVGctF":{"name":"fetchTransactions(forAddress:limit:completion:)","abstract":"

Fetch all transactions, both account operations, and token transfers, and combine them into 1 response

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:14KukaiCoreSwift10TzKTClientC17groupTransactions12transactions20currentWalletAddressSayAA0D18KTTransactionGroupVGSayAA0dL0VG_SStF":{"name":"groupTransactions(transactions:currentWalletAddress:)","abstract":"

Group transactions into logical groups, so user doesn’t see N enteries for 1 contract call resulting in many internal operations

","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:13SignalRClient21HubConnectionDelegateP17connectionDidOpen03hubD0yAA0cD0C_tF":{"name":"connectionDidOpen(hubConnection:)","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:13SignalRClient21HubConnectionDelegateP18connectionDidClose5errorys5Error_pSg_tF":{"name":"connectionDidClose(error:)","parent_name":"TzKTClient"},"Classes/TzKTClient.html#/s:13SignalRClient21HubConnectionDelegateP23connectionDidFailToOpen5errorys5Error_p_tF":{"name":"connectionDidFailToOpen(error:)","parent_name":"TzKTClient"},"Classes/TezosNodeClient/TezosNodeClientError.html#/s:14KukaiCoreSwift15TezosNodeClientC0deF5ErrorO28noDexterExchangeAddressFoundyA2EmF":{"name":"noDexterExchangeAddressFound","parent_name":"TezosNodeClientError"},"Classes/TezosNodeClient/TezosNodeClientError.html#/s:14KukaiCoreSwift15TezosNodeClientC0deF5ErrorO16michelsonParsingyA2EmF":{"name":"michelsonParsing","parent_name":"TezosNodeClientError"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC6configAA0deF6ConfigVvp":{"name":"config","abstract":"

The configuration object containing all the necessary settings to connect and communicate with the Tezos node

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC14networkServiceAA07NetworkH0Cvp":{"name":"networkService","abstract":"

The NetworkService object that will perform all the networking calls

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC16operationServiceAA09OperationH0Cvp":{"name":"operationService","abstract":"

The OperationService object that will perform forging, parsing, signing, preapply and injections of operations

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC19feeEstimatorServiceAA03FeehI0Cvp":{"name":"feeEstimatorService","abstract":"

The service responsible for calculating network fees on behalf of the user

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC14networkVersionAA07NetworkH0VSgvp":{"name":"networkVersion","abstract":"

Available information about the version of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC16networkConstantsAA07NetworkH0VSgvp":{"name":"networkConstants","abstract":"

Available information about the constants of the network, that the conected server is running. Call tezosNodeClient.fetchNetworkInformation(...) to populate

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient/TezosNodeClientError.html":{"name":"TezosNodeClientError","abstract":"

Types of errors

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC6configAcA0deF6ConfigV_tcfc":{"name":"init(config:)","abstract":"

Init a TezosNodeClient with a TezosNodeClientConfig.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC10getBalance10forAddress10completionySS_ys6ResultOyAA9XTZAmountCAA0A5ErrorVGctF":{"name":"getBalance(forAddress:completion:)","abstract":"

Gets the xtz balance for a given Address.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC11getDelegate10forAddress10completionySS_ys6ResultOySSAA0A5ErrorVGctF":{"name":"getDelegate(forAddress:completion:)","abstract":"

Gets the delegate for the given address.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC8estimate10operations13walletAddress22base58EncodedPublicKey10completionySayAA9OperationCG_S2Sys6ResultOyAA19FeeEstimatorServiceC010EstimationQ0VAA0A5ErrorVGctF":{"name":"estimate(operations:walletAddress:base58EncodedPublicKey:completion:)","abstract":"

Take an array of operations and estimate the gas, storage, baker fee and burn fees required to inject it onto the network","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC4send10operations10withWallet10completionySayAA9OperationCG_AA0J0_pys6ResultOySSAA0A5ErrorVGctF":{"name":"send(operations:withWallet:completion:)","abstract":"

Send an array of Operation‘s to the blockchain. Use OperationFactory to help create this array for common use cases.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC4send16operationPayload0H8Metadata10withWallet10completionyAA09OperationI0V_AA0nJ0VAA0L0_pys6ResultOySSAA0A5ErrorVGctF":{"name":"send(operationPayload:operationMetadata:withWallet:completion:)","abstract":"

Send an already contrsutructed OperationPayload with the necessary OperationMetadata without having to fetch metadata again.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC20getOperationMetadata16forWalletAddress10completionySS_ys6ResultOyAA0hI0VAA0A5ErrorVGctF":{"name":"getOperationMetadata(forWalletAddress:completion:)","abstract":"

Get all the metadata necessary from the network to perform operations.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC18getContractStorage15contractAddress10completionySS_ys6ResultOySDySSypGAA0A5ErrorVGctF":{"name":"getContractStorage(contractAddress:completion:)","abstract":"

Get the Michelson storage of a given contract from the blockchain.

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC9getBigMap2id10completionySS_ys6ResultOySDySSypGAA0A5ErrorVGctF":{"name":"getBigMap(id:completion:)","abstract":"

Get the Michelson big map contents, from a given id

","parent_name":"TezosNodeClient"},"Classes/TezosNodeClient.html#/s:14KukaiCoreSwift15TezosNodeClientC21getNetworkInformation10completionyySb_AA0A5ErrorVSgtc_tF":{"name":"getNetworkInformation(completion:)","abstract":"

Query the server for the NetworkVersion and NetworkConstants, and store the responses in the tezosNodeClient properties networkVersion and networkConstants,","parent_name":"TezosNodeClient"},"Classes/TezosDomainsClient/BothNetworkReverseRecord.html#/s:14KukaiCoreSwift18TezosDomainsClientC24BothNetworkReverseRecordV7mainnetAA0deiJ0VSgvp":{"name":"mainnet","parent_name":"BothNetworkReverseRecord"},"Classes/TezosDomainsClient/BothNetworkReverseRecord.html#/s:14KukaiCoreSwift18TezosDomainsClientC24BothNetworkReverseRecordV8ghostnetAA0deiJ0VSgvp":{"name":"ghostnet","parent_name":"BothNetworkReverseRecord"},"Classes/TezosDomainsClient/BothNetworkReverseRecord.html#/s:14KukaiCoreSwift18TezosDomainsClientC24BothNetworkReverseRecordV7mainnet8ghostnetAeA0deiJ0VSg_AJtcfc":{"name":"init(mainnet:ghostnet:)","parent_name":"BothNetworkReverseRecord"},"Classes/TezosDomainsClient/BothNetworkReverseRecord.html":{"name":"BothNetworkReverseRecord","abstract":"

Object to wrap up a response fomr both networks

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC14networkService6configAcA07NetworkH0C_AA0d4NodeF6ConfigVtcfc":{"name":"init(networkService:config:)","abstract":"

Init a TezosDomainsClient with a NetworkService and a TezosNodeClientConfig.

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC12getDomainFor7address3url10completionySS_10Foundation3URLVSgys6ResultOyAA15GraphQLResponseVyAA0deH8ResponseVGAA0A5ErrorVGctF":{"name":"getDomainFor(address:url:completion:)","abstract":"

Get Tezos domain response for a given address

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC24getMainAndGhostDomainFor7address10completionySS_ys6ResultOyAC24BothNetworkReverseRecordVAA0A5ErrorVGctF":{"name":"getMainAndGhostDomainFor(address:completion:)","abstract":"

Query both mainnet and ghostnet versions of Tezos domains to find all records for the given address

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC13getAddressFor6domain10completionySS_ys6ResultOyAA15GraphQLResponseVyAA0deH8ResponseVGAA0A5ErrorVGctF":{"name":"getAddressFor(domain:completion:)","abstract":"

Find the tz address of a given domain

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC03getE3For9addresses3url10completionySaySSG_10Foundation3URLVSgys6ResultOyAA15GraphQLResponseVyAA0dE18DomainBulkResponseVGAA0A5ErrorVGctF":{"name":"getDomainsFor(addresses:url:completion:)","abstract":"

Bulk function for fetching domains for an array of addresses

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC015getMainAndGhostE3For9addresses10completionySaySSG_ys6ResultOySDySSAC24BothNetworkReverseRecordVGAA0A5ErrorVGctF":{"name":"getMainAndGhostDomainsFor(addresses:completion:)","abstract":"

Bulk function for fetching domains for an array of addresses, check ghostnet and mainnet for each

","parent_name":"TezosDomainsClient"},"Classes/TezosDomainsClient.html#/s:14KukaiCoreSwift18TezosDomainsClientC15getAddressesFor7domains10completionySaySSG_ys6ResultOyAA15GraphQLResponseVyAA0dE19AddressBulkResponseVGAA0A5ErrorVGctF":{"name":"getAddressesFor(domains:completion:)","abstract":"

Bulk function to find all domains for a list of addresses

","parent_name":"TezosDomainsClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC11collectionsSDySSAA0D10CollectionVGvp":{"name":"collections","abstract":"

Cached metadata of NFT collections, e.g. name, thumbnailURL etc

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC6tokensSDySSAA0D12TokenReponseVGvp":{"name":"tokens","abstract":"

Cached metadata of specific tokens, e.g. prices, offers etc

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC14networkService6configAcA07NetworkG0C_AA09TezosNodeE6ConfigVtcfc":{"name":"init(networkService:config:)","abstract":"

Init a ObjktClient with a NetworkService and a TezosNodeClientConfig.

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC21unresolvedCollections9addressesSaySSGAF_tF":{"name":"unresolvedCollections(addresses:)","abstract":"

Take in an array of contract addresses, and return a list of the ones that we currently have no metadata for

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC21resolveCollectionsAll9addresses10completionySaySSG_ys6ResultOySbAA0A5ErrorVGctF":{"name":"resolveCollectionsAll(addresses:completion:)","abstract":"

Search OBJKT to find metadata on the list of addresses provided

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC22resolveCollectionsPage9addresses10completionys10ArraySliceVySSG_ys6ResultOyAA15GraphQLResponseVyAA0dG0VGAA0A5ErrorVGctF":{"name":"resolveCollectionsPage(addresses:completion:)","abstract":"

Find the metadata of a list of contracts, used recurrisvely to find all collections while limited to request query size

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC12resolveToken7address7tokenId21forOwnerWalletAddress10completionySS_So9NSDecimalaSSys6ResultOyAA15GraphQLResponseVyAA0dG7ReponseVGAA0A5ErrorVGctF":{"name":"resolveToken(address:tokenId:forOwnerWalletAddress:completion:)","abstract":"

Find the meatdata of a specific token

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC13tokenResponse10forAddress0F2IdAA0D12TokenReponseVSgSS_SitF":{"name":"tokenResponse(forAddress:tokenId:)","abstract":"

Helper to fetch a specific token metadata from the cache

","parent_name":"ObjktClient"},"Classes/ObjktClient.html#/s:14KukaiCoreSwift11ObjktClientC11deleteCacheyyF":{"name":"deleteCache()","abstract":"

Clear all the cached data

","parent_name":"ObjktClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC15dexMaxQuerySizeSivpZ":{"name":"dexMaxQuerySize","abstract":"

Max enteries to return per request

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC14networkService6configAcA07NetworkH0C_AA09TezosNodeF6ConfigVtcfc":{"name":"init(networkService:config:)","abstract":"

Init a DipDupClient with a NetworkService and a TezosNodeClientConfig.

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC21getExchangesAndTokens5limit6offset10completionySi_Siys6ResultOyAA15GraphQLResponseVyAA0dehiJ8ResponseVGAA0A5ErrorVGctF":{"name":"getExchangesAndTokens(limit:offset:completion:)","abstract":"

Get a list of all the tokens available and on what excahnges (including their prices and pool data)

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC24getAllExchangesAndTokens10completionyys6ResultOySayAA0deijK0VGAA0A5ErrorVGc_tF":{"name":"getAllExchangesAndTokens(completion:)","abstract":"

Recurrsively call getExchangesAndTokens(...) until we have found all the tokens

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC15getLiquidityFor7address10completionySS_ys6ResultOyAA15GraphQLResponseVyAA0dE8PositionVGAA0A5ErrorVGctF":{"name":"getLiquidityFor(address:completion:)","abstract":"

Query a given addresses liquidity token balances

","parent_name":"DipDupClient"},"Classes/DipDupClient.html#/s:14KukaiCoreSwift12DipDupClientC15getChartDataFor16exchangeContract7nowDate10completionySS_10Foundation0N0Vys6ResultOyAA15GraphQLResponseVyAA0dehI0VGAA0A5ErrorVGctF":{"name":"getChartDataFor(exchangeContract:nowDate:completion:)","abstract":"

Query a given contract address for pricing data for the given token

","parent_name":"DipDupClient"},"Classes/BetterCallDevClient/BetterCallDevClientError.html#/s:14KukaiCoreSwift19BetterCallDevClientC0defG5ErrorO10invalidURLyA2EmF":{"name":"invalidURL","parent_name":"BetterCallDevClientError"},"Classes/BetterCallDevClient/BetterCallDevClientError.html#/s:14KukaiCoreSwift19BetterCallDevClientC0defG5ErrorO05parseH0yAESScAEmF":{"name":"parseError(_:)","parent_name":"BetterCallDevClientError"},"Classes/BetterCallDevClient/BetterCallDevClientError.html":{"name":"BetterCallDevClientError","abstract":"

Dedicated BCD errors

","parent_name":"BetterCallDevClient"},"Classes/BetterCallDevClient.html#/s:14KukaiCoreSwift19BetterCallDevClientC14networkService6configAcA07NetworkI0C_AA09TezosNodeG6ConfigVtcfc":{"name":"init(networkService:config:)","abstract":"

Init a BetterCallDevClient with a NetworkService and a TezosNodeClientConfig.

","parent_name":"BetterCallDevClient"},"Classes/BetterCallDevClient.html#/s:14KukaiCoreSwift19BetterCallDevClientC20getMoreDetailedError6byHash10completionySS_yAA0def9OperationK0VSg_AA0aK0VSgtctF":{"name":"getMoreDetailedError(byHash:completion:)","abstract":"

Primarily the TzKTClient is used to fetch details on operations. However for more complex calls involving smart contracts, TzKT will only return limited error message info.","parent_name":"BetterCallDevClient"},"Classes/BetterCallDevClient.html":{"name":"BetterCallDevClient","abstract":"

BetterCallDev (BCD) is an indexer/smart contract debugging tool, used for the Tezos blockchain."},"Classes/DipDupClient.html":{"name":"DipDupClient","abstract":"

This client exposes functions to allow communication to the indexer platform DipDup ( https://dipdup.net/ )."},"Classes/ObjktClient.html":{"name":"ObjktClient","abstract":"

Client for interacting with the API of the popular NFT marketplace, OBJKT.com"},"Classes/TezosDomainsClient.html":{"name":"TezosDomainsClient","abstract":"

A client class allowing integration with the tezos domains GraphQL API. See more here: https://tezos.domains/

"},"Classes/TezosNodeClient.html":{"name":"TezosNodeClient","abstract":"

The TezosNodeClient offers methods for interacting with the Tezos node to fetch balances, send transactions etc."},"Classes/TzKTClient.html":{"name":"TzKTClient","abstract":"

TzKT is an indexer for Tezos, who’s API allows developers to query details about wallets, transactions, bakers, account status etc

"},"Classes/OperationFactory.html":{"name":"OperationFactory","abstract":"

Class responsible for creating operations necessary to perform a given action, and converting those operations into the single payload expected by the RPC."},"Classes/BetterCallDevTokenMetadata.html":{"name":"BetterCallDevTokenMetadata","abstract":"

A model matching the response that comes back from BetterCallDev’s API: v1/tokens/<network>/metadata?contract=<address>

"},"Classes/HDWallet.html":{"name":"HDWallet","abstract":"

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address."},"Classes/LedgerWallet.html":{"name":"LedgerWallet","abstract":"

A Tezos wallet class, used to cache infomration regarding the paired ledger device used to sign the payload."},"Classes/Operation.html":{"name":"Operation","abstract":"

Base class representing an Operation on the Tezos network. On its own this class can’t be sent to the network. See its subclasses for more info.

"},"Classes/OperationActivateAccount.html":{"name":"OperationActivateAccount","abstract":"

Operation subclass for revealing a publickey to the network.

"},"Classes/OperationBallot.html":{"name":"OperationBallot","abstract":"

Operation to submit a ballot on an upcoming proposal

"},"Classes/OperationDelegation.html":{"name":"OperationDelegation","abstract":"

Operation subclass for delegating an account to a baker

"},"Classes/OperationDoubleBakingEvidence.html":{"name":"OperationDoubleBakingEvidence","abstract":"

Operation to report a baking of baking the same block twice

"},"Classes/OperationDoubleEndorsementEvidence.html":{"name":"OperationDoubleEndorsementEvidence","abstract":"

Operation to report a baker trying to endorse a block twice

"},"Classes/OperationEndorsement.html":{"name":"OperationEndorsement","abstract":"

Operation for endorsing a block

"},"Classes/OperationOrigination.html":{"name":"OperationOrigination","abstract":"

Operation subclass for originating a contract on the Tezos network

"},"Classes/OperationProposals.html":{"name":"OperationProposals"},"Classes/OperationReveal.html":{"name":"OperationReveal","abstract":"

Operation subclass for revealing a publickey to the network.

"},"Classes/OperationSeedNonceRevelation.html":{"name":"OperationSeedNonceRevelation","abstract":"

Operation to reveal seed nonce to blockchain

"},"Classes/OperationTransaction.html":{"name":"OperationTransaction","abstract":"

Operation subclass for sending XTZ to a destination

"},"Classes/RPC.html":{"name":"RPC","abstract":"

A generic class representing an RPC call to the Tezos network."},"Classes/RegularWallet.html":{"name":"RegularWallet","abstract":"

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address."},"Classes/Token.html":{"name":"Token","abstract":"

A class to represent a Token on the Tezos network. This class will do all the heavy lifting of converting values from the RPC to more human readbale values."},"Classes/TokenAmount.html":{"name":"TokenAmount","abstract":"

Class representing a numeric amount on the Tezos network. The network uses natural numbers inside strings, which technically have an infinite length."},"Classes/TorusWallet.html":{"name":"TorusWallet","abstract":"

A Tezos Wallet used for signing transactions before sending to the Tezos network. This object holds the public and private key used to create the contained Tezos address."},"Classes/XTZAmount.html":{"name":"XTZAmount","abstract":"

A subclass of TokenAmount to make it more explict when functions require XTZ (such as network fees)."},"Classes/DAppHelperService.html":{"name":"DAppHelperService","abstract":"

A Helper service to simply combine multiple calls from other services, and/or map to specific responses, in order to expose a piece of functionality provided by a dApp

"},"Classes/DexCalculationService.html":{"name":"DexCalculationService","abstract":"

Wrapper around the kukai-dex-calculations JS library for performing calculations: https://github.com/kukai-wallet/kukai-dex-calculations

"},"Classes/DiskService.html":{"name":"DiskService","abstract":"

A service class to write and read data from the devices documents directory

"},"Classes/ErrorHandlingService.html":{"name":"ErrorHandlingService","abstract":"

A class used to process errors into more readable format, and optionally notifiy a global error handler of every error occuring

"},"Classes/FeeEstimatorService.html":{"name":"FeeEstimatorService","abstract":"

An object allowing developers to automatically estimate the necessary fee per Operation to ensure it will be accpeted by a Baker."},"Classes/LedgerService.html":{"name":"LedgerService","abstract":"

A service class to wrap up all the complicated interactions with CoreBluetooth and the modified version of ledgerjs, needed to communicate with a Ledger Nano X.

"},"Classes/MediaProxyService.html":{"name":"MediaProxyService","abstract":"

A service class for interacting with the TC infrastructure to proxy NFT images, videos and audio files

"},"Classes/ContentTypeCheckingImageDownloader.html":{"name":"ContentTypeCheckingImageDownloader"},"Classes/NetworkService.html":{"name":"NetworkService","abstract":"

Class responsible for sending all the networking requests, checking for http errors, RPC errors, Decoding the responses and optionally logging progress

"},"Classes/OperationService.html":{"name":"OperationService","abstract":"

Several classes need to use pieces of the forge-sign-parse-preapply-inject flow. This class abstracts those functions away so that it can be shared throughout the library.

"},"Classes/TaquitoService.html":{"name":"TaquitoService","abstract":"

Taquito (https://github.com/ecadlabs/taquito) is a popular open source Tezos library written in Typescript and Javascript."},"Classes/TorusAuthService.html":{"name":"TorusAuthService","abstract":"

TorusAuthService is a wrapper around the SDK provided by: https://tor.us/ to allow the creation of TorusWallet‘s."},"Classes/WalletCacheService.html":{"name":"WalletCacheService","abstract":"

A service class used to store and retrieve Wallet objects such as RegularWallet, HDWallet, LedgerWallet and TorusWallet from the devices disk."},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Extensions.html":{"name":"Extensions","abstract":"

The following extensions are available globally.

"},"Protocols.html":{"name":"Protocols","abstract":"

The following protocols are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"},"Typealiases.html":{"name":"Type Aliases","abstract":"

The following type aliases are available globally.

"}} \ No newline at end of file diff --git a/undocumented.json b/undocumented.json new file mode 100644 index 00000000..8744c941 --- /dev/null +++ b/undocumented.json @@ -0,0 +1,6 @@ +{ + "warnings": [ + + ], + "source_directory": "/Users/runner/work/kukai-core-swift/kukai-core-swift" +} \ No newline at end of file