-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Profile - Third-Party deposits (#680)
- Loading branch information
1 parent
c35f978
commit 345bd1c
Showing
5 changed files
with
276 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
Sources/Profile/Entity/OnLedgerSettings/Account+OnLedgerSettings.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| import EngineKit | ||
| import Prelude | ||
|
|
||
| // MARK: - Profile.Network.Account.OnLedgerSettings | ||
| extension Profile.Network.Account { | ||
| public struct OnLedgerSettings: Hashable, Sendable, Codable { | ||
| /// Controls the ability of third-parties to deposit into this account | ||
| public var thirdPartyDeposits: ThirdPartyDeposits | ||
|
|
||
| public init(thirdPartyDeposits: ThirdPartyDeposits) { | ||
| self.thirdPartyDeposits = thirdPartyDeposits | ||
| } | ||
|
|
||
| /// The default value for newly created accounts. | ||
| /// After the account is created the OnLedgerSettings will be updated either by User or by syncing with the Ledger. | ||
| public static let `default` = Self(thirdPartyDeposits: .default) | ||
| } | ||
| } | ||
|
|
||
| // MARK: - Profile.Network.Account.OnLedgerSettings.ThirdPartyDeposits | ||
| extension Profile.Network.Account.OnLedgerSettings { | ||
| public struct ThirdPartyDeposits: Hashable, Sendable, Codable { | ||
| /// The general deposit rule to apply | ||
| public enum DepositRule: String, Hashable, Sendable, Codable, CaseIterable { | ||
| case acceptAll | ||
| case acceptKnown | ||
| case denyAll | ||
| } | ||
|
|
||
| /// The addresses that can be added as exception to the `DepositRule` | ||
| public enum DepositAddress: Hashable, Sendable, Codable { | ||
| case resourceAddress(ResourceAddress) | ||
| case nonFungibleGlobalID(NonFungibleGlobalId) | ||
| } | ||
|
|
||
| /// The exception kind for deposit address | ||
| public enum DepositAddressExceptionRule: String, Hashable, Sendable, Codable, CaseIterable { | ||
| /// A resource can always be deposited in to the account by third-parties | ||
| case allow | ||
| /// A resource can never be deposited in to the account by third-parties | ||
| case deny | ||
| } | ||
|
|
||
| /// The specific Asset exception rule | ||
| public struct AssetException: Hashable, Sendable, Codable { | ||
| public let address: DepositAddress | ||
| public let exceptionRule: DepositAddressExceptionRule | ||
|
|
||
| public init(address: DepositAddress, exceptionRule: DepositAddressExceptionRule) { | ||
| self.address = address | ||
| self.exceptionRule = exceptionRule | ||
| } | ||
| } | ||
|
|
||
| /// Controls the ability of thir-parties to deposit into this account | ||
| public var depositRule: DepositRule | ||
|
|
||
| /// Denies or allows third-party deposits of specific assets by ignoring the `depositMode` | ||
| public var assetsExceptionList: OrderedSet<AssetException> | ||
|
|
||
| /// Allows certain third-party depositors to deposit assets freely. | ||
| /// Note: There is no `deny` counterpart for this. | ||
| public var depositorsAllowList: OrderedSet<DepositAddress> | ||
|
|
||
| public init( | ||
| depositRule: DepositRule, | ||
| assetsExceptionList: OrderedSet<AssetException>, | ||
| depositorsAllowList: OrderedSet<DepositAddress> | ||
| ) { | ||
| self.depositRule = depositRule | ||
| self.assetsExceptionList = assetsExceptionList | ||
| self.depositorsAllowList = depositorsAllowList | ||
| } | ||
|
|
||
| /// On Ledger default is `acceptAll` for deposit mode and empty lists | ||
| public static let `default` = Self(depositRule: .acceptAll, assetsExceptionList: [], depositorsAllowList: []) | ||
| } | ||
| } | ||
|
|
||
| /// Override default Hashable conformance to use only the Address for hashing and comparison, | ||
| /// assuring that there is only one exception rule for a given Address in the Set. | ||
| extension Profile.Network.Account.OnLedgerSettings.ThirdPartyDeposits.AssetException { | ||
| public func hash(into hasher: inout Hasher) { | ||
| hasher.combine(address) | ||
| } | ||
|
|
||
| public static func == (lhs: Self, rhs: Self) -> Bool { | ||
| lhs.address == rhs.address | ||
| } | ||
| } | ||
|
|
||
| extension Profile.Network.Account.OnLedgerSettings.ThirdPartyDeposits.DepositAddress { | ||
| private enum CodingKeys: String, CodingKey { | ||
| case discriminator | ||
| case value | ||
| } | ||
|
|
||
| enum Discriminator: String, Sendable, Hashable, CustomStringConvertible, Codable { | ||
| case resourceAddress, nonFungibleGlobalID | ||
|
|
||
| public var description: String { | ||
| rawValue | ||
| } | ||
| } | ||
|
|
||
| public init(from decoder: Decoder) throws { | ||
| let container = try decoder.container(keyedBy: CodingKeys.self) | ||
|
|
||
| let discriminator = try container.decode(Discriminator.self, forKey: .discriminator) | ||
| let value = try container.decode(String.self, forKey: .value) | ||
|
|
||
| switch discriminator { | ||
| case .resourceAddress: | ||
| self = try .resourceAddress(.init(validatingAddress: value)) | ||
| case .nonFungibleGlobalID: | ||
| self = try .nonFungibleGlobalID(.init(nonFungibleGlobalId: value)) | ||
| } | ||
| } | ||
|
|
||
| public func encode(to encoder: Encoder) throws { | ||
| var container = encoder.container(keyedBy: CodingKeys.self) | ||
|
|
||
| switch self { | ||
| case let .resourceAddress(address): | ||
| try container.encode(Discriminator.resourceAddress, forKey: .discriminator) | ||
| try container.encode(address.address, forKey: .value) | ||
|
|
||
| case let .nonFungibleGlobalID(id): | ||
| try container.encode(Discriminator.nonFungibleGlobalID, forKey: .discriminator) | ||
| try container.encode(id.asStr(), forKey: .value) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters