Skip to content
This repository has been archived by the owner on Feb 15, 2024. It is now read-only.

Commit

Permalink
docs: rename instances of ImmutableX
Browse files Browse the repository at this point in the history
ImmutableX is the accepted form of referring to the platform moving
forward.
  • Loading branch information
CassiusPacheco committed Nov 9, 2022
1 parent 3acb01d commit 35688b6
Show file tree
Hide file tree
Showing 13 changed files with 35 additions and 35 deletions.
4 changes: 2 additions & 2 deletions ImmutableXCore.podspec
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Pod::Spec.new do |spec|
spec.name = 'ImmutableXCore'
spec.version = '0.4.0'
spec.summary = 'The Immutable X Core SDK Swift for applications written on the Immutable X platform.'
spec.summary = 'The ImmutableX Core SDK Swift for applications written on the ImmutableX platform.'

spec.description = <<-DESC
The Immutable Core SDK Swift provides convenient access to the Immutable API's for applications written on the Immutable X platform.
The Immutable Core SDK Swift provides convenient access to the Immutable API's for applications written on the ImmutableX platform.
DESC

spec.homepage = 'https://github.com/immutable/imx-core-sdk-swift'
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@

---

# Immutable X Core SDK Swift
# ImmutableX Core SDK Swift

[![Maintainability](https://api.codeclimate.com/v1/badges/a7887f9758562e49b171/maintainability)](https://codeclimate.com/repos/62be55bacb1f54014d00579d/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/a7887f9758562e49b171/test_coverage)](https://codeclimate.com/repos/62be55bacb1f54014d00579d/test_coverage)

The Immutable X Core SDK Swift provides convenient access to the Immutable API's for applications written on the Immutable X platform.
The ImmutableX Core SDK Swift provides convenient access to the Immutable API's for applications written on the ImmutableX platform.

## Documentation

See the [developer guides](https://docs.x.immutable.com) for information on building on Immutable X.
See the [developer guides](https://docs.x.immutable.com) for information on building on ImmutableX.

See the [API reference documentation](https://docs.x.immutable.com/reference) for more information on our API's.

Expand Down Expand Up @@ -68,7 +68,7 @@ let url = try await ImmutableX.shared.buyCryptoURL(signer: signer)

Utility functions accessed via `ImmutableX.shared` that will chain necessary API calls to complete a process or perform a transaction.

- Register a user with Immutable X
- Register a user with ImmutableX
- Buy cryptocurrency via Moonpay
- Buy ERC721
- Sell ERC721
Expand All @@ -77,7 +77,7 @@ Utility functions accessed via `ImmutableX.shared` that will chain necessary API

### Standard API Requests

The Core SDK includes classes that interact with the Immutable X APIs.
The Core SDK includes classes that interact with the ImmutableX APIs.

e.g. Get a list of collections ordered by name in ascending order

Expand Down Expand Up @@ -162,7 +162,7 @@ If you would like to contribute by reporting bugs, suggest enchacements or pull

## Getting Help

Immutable X is open to all to build on, with no approvals required. If you want to talk to us to learn more, or apply for developer grants, click below:
ImmutableX is open to all to build on, with no approvals required. If you want to talk to us to learn more, or apply for developer grants, click below:

[Contact us](https://www.immutable.com/contact)

Expand All @@ -172,16 +172,16 @@ To get help from other developers, discuss ideas, and stay up-to-date on what's

[Join us on Discord](https://discord.gg/TkVumkJ9D6)

You can also join the conversation, connect with other projects, and ask questions in our Immutable X Discourse forum.
You can also join the conversation, connect with other projects, and ask questions in our ImmutableX Discourse forum.

[Visit the forum](https://forum.immutable.com/)

#### Still need help?

You can also apply for marketing support for your project. Or, if you need help with an issue related to what you're building with Immutable X, click below to submit an issue. Select _I have a question_ or _issue related to building on Immutable X_ as your issue type.
You can also apply for marketing support for your project. Or, if you need help with an issue related to what you're building with ImmutableX, click below to submit an issue. Select _I have a question_ or _issue related to building on ImmutableX_ as your issue type.

[Contact support](https://support.immutable.com/hc/en-us/requests/new)

## License

Immutable X Core SDK Swift repository is distributed under the terms of the [Apache License (Version 2.0)](LICENSE).
ImmutableX Core SDK Swift repository is distributed under the terms of the [Apache License (Version 2.0)](LICENSE).
4 changes: 2 additions & 2 deletions Sources/ImmutableXCore/Generated/Models/Asset.swift
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public struct Asset: Codable, Hashable {
public private(set) var description: String?
/** Royalties to pay on this asset operations */
public private(set) var fees: [Fee]?
/** [DEPRECATED] Internal Immutable X Token ID */
/** [DEPRECATED] Internal ImmutableX Token ID */
public private(set) var id: String?
/** URL of the image which should be used for this asset */
public private(set) var imageUrl: String?
Expand All @@ -36,7 +36,7 @@ public struct Asset: Codable, Hashable {
public private(set) var tokenId: String
/** Timestamp of when the asset was updated */
public private(set) var updatedAt: String?
/** URI to access this asset externally to Immutable X */
/** URI to access this asset externally to ImmutableX */
public private(set) var uri: String?
/** Ethereum address of the user who owns this asset */
public private(set) var user: String
Expand Down
4 changes: 2 additions & 2 deletions Sources/ImmutableXCore/Generated/Models/AssetWithOrders.swift
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public struct AssetWithOrders: Codable, Hashable {
public private(set) var description: String?
/** Royalties to pay on this asset operations */
public private(set) var fees: [Fee]?
/** [DEPRECATED] Internal Immutable X Token ID */
/** [DEPRECATED] Internal ImmutableX Token ID */
public private(set) var id: String?
/** URL of the image which should be used for this asset */
public private(set) var imageUrl: String?
Expand All @@ -36,7 +36,7 @@ public struct AssetWithOrders: Codable, Hashable {
public private(set) var tokenId: String
/** Timestamp of when the asset was updated */
public private(set) var updatedAt: String?
/** URI to access this asset externally to Immutable X */
/** URI to access this asset externally to ImmutableX */
public private(set) var uri: String?
/** Ethereum address of the user who owns this asset */
public private(set) var user: String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public struct CreateTradeResponse: Codable, Hashable {
public private(set) var requestId: String?
/** Current status of trade */
public private(set) var status: String
/** ID of trade within Immutable X */
/** ID of trade within ImmutableX */
public private(set) var tradeId: Int

public init(requestId: String? = nil, status: String, tradeId: Int) {
Expand Down
4 changes: 2 additions & 2 deletions Sources/ImmutableXCore/Generated/Models/Deposit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ import AnyCodable

public struct Deposit: Codable, Hashable {

/** Status of this deposit in Immutable X */
/** Status of this deposit in ImmutableX */
public private(set) var status: String
/** Timestamp of the deposit */
public private(set) var timestamp: String
public private(set) var token: Token
/** Sequential ID of this transaction within Immutable X */
/** Sequential ID of this transaction within ImmutableX */
public private(set) var transactionId: Int
/** Ethereum address of the user making this deposit */
public private(set) var user: String
Expand Down
2 changes: 1 addition & 1 deletion Sources/ImmutableXCore/Generated/Models/Mint.swift
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public struct Mint: Codable, Hashable {
/** Timestamp this mint was initiated */
public private(set) var timestamp: String
public private(set) var token: Token
/** Sequential ID of transaction in Immutable X */
/** Sequential ID of transaction in ImmutableX */
public private(set) var transactionId: Int
/** Ethereum address of the user to whom the asset has been minted */
public private(set) var user: String
Expand Down
2 changes: 1 addition & 1 deletion Sources/ImmutableXCore/Generated/Models/TokenData.swift
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public struct TokenData: Codable, Hashable {

/** Number of decimals supported by this asset */
public private(set) var decimals: Int?
/** [DEPRECATED] Internal Immutable X Token ID */
/** [DEPRECATED] Internal ImmutableX Token ID */
public private(set) var id: String?
public private(set) var properties: AssetProperties?
/** Quantity of this asset */
Expand Down
2 changes: 1 addition & 1 deletion Sources/ImmutableXCore/Generated/Models/Trade.swift
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public struct Trade: Codable, Hashable {
public private(set) var status: String
/** Time this trade occurred */
public private(set) var timestamp: String?
/** Sequential ID of this trade within Immutable X */
/** Sequential ID of this trade within ImmutableX */
public private(set) var transactionId: Int

public init(a: TradeSide, b: TradeSide, status: String, timestamp: String?, transactionId: Int) {
Expand Down
2 changes: 1 addition & 1 deletion Sources/ImmutableXCore/ImmutableX.swift
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ public struct ImmutableX {
try await transferWorkflow.transfer(token: token, recipientAddress: recipientAddress, signer: signer, starkSigner: starkSigner)
}

/// This is a utility function that will register a user to Immutable X if they aren't already
/// This is a utility function that will register a user to ImmutableX if they aren't already
///
/// - Parameters:
/// - signer: represents the users L1 wallet to get the address
Expand Down
2 changes: 1 addition & 1 deletion Sources/ImmutableXCore/Signer.swift
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public protocol Signer {
func signMessage(_ message: String) async throws -> String
}

/// This represents the Immutable X Wallet on Layer 2 and will have reference to the user's Stark key pair for signing L2 transactions.
/// This represents the ImmutableX Wallet on Layer 2 and will have reference to the user's Stark key pair for signing L2 transactions.
public protocol StarkSigner {
/// This is an async method so that a ``Signer`` can be designed around an asynchronous source,
/// such as hardware wallets.
Expand Down
2 changes: 1 addition & 1 deletion Sources/ImmutableXCore/Workflows/RegisterWorkflow.swift
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import Foundation

class RegisterWorkflow {
/// This is a utility function that will register a user to Immutable X if they aren't already
/// This is a utility function that will register a user to ImmutableX if they aren't already
///
/// - Parameters:
/// - signer: represents the users L1 wallet to get the address
Expand Down
22 changes: 11 additions & 11 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
],
"swagger": "2.0",
"info": {
"title": "Immutable X API",
"title": "ImmutableX API",
"contact": {
"name": "Immutable API Support",
"email": "[email protected]"
Expand Down Expand Up @@ -2758,7 +2758,7 @@
}
},
"id": {
"description": "[DEPRECATED] Internal Immutable X Token ID",
"description": "[DEPRECATED] Internal ImmutableX Token ID",
"type": "string"
},
"image_url": {
Expand Down Expand Up @@ -2798,7 +2798,7 @@
"x-nullable": true
},
"uri": {
"description": "URI to access this asset externally to Immutable X",
"description": "URI to access this asset externally to ImmutableX",
"type": "string",
"x-nullable": true
},
Expand Down Expand Up @@ -2864,7 +2864,7 @@
}
},
"id": {
"description": "[DEPRECATED] Internal Immutable X Token ID",
"description": "[DEPRECATED] Internal ImmutableX Token ID",
"type": "string"
},
"image_url": {
Expand Down Expand Up @@ -2904,7 +2904,7 @@
"x-nullable": true
},
"uri": {
"description": "URI to access this asset externally to Immutable X",
"description": "URI to access this asset externally to ImmutableX",
"type": "string",
"x-nullable": true
},
Expand Down Expand Up @@ -3333,7 +3333,7 @@
"type": "string"
},
"trade_id": {
"description": "ID of trade within Immutable X",
"description": "ID of trade within ImmutableX",
"type": "integer"
}
}
Expand Down Expand Up @@ -3522,7 +3522,7 @@
],
"properties": {
"status": {
"description": "Status of this deposit in Immutable X",
"description": "Status of this deposit in ImmutableX",
"type": "string"
},
"timestamp": {
Expand All @@ -3534,7 +3534,7 @@
"$ref": "#/definitions/Token"
},
"transaction_id": {
"description": "Sequential ID of this transaction within Immutable X",
"description": "Sequential ID of this transaction within ImmutableX",
"type": "integer"
},
"user": {
Expand Down Expand Up @@ -4571,7 +4571,7 @@
"$ref": "#/definitions/Token"
},
"transaction_id": {
"description": "Sequential ID of transaction in Immutable X",
"description": "Sequential ID of transaction in ImmutableX",
"type": "integer"
},
"user": {
Expand Down Expand Up @@ -5072,7 +5072,7 @@
"type": "integer"
},
"id": {
"description": "[DEPRECATED] Internal Immutable X Token ID",
"description": "[DEPRECATED] Internal ImmutableX Token ID",
"type": "string"
},
"properties": {
Expand Down Expand Up @@ -5162,7 +5162,7 @@
"x-nullable": true
},
"transaction_id": {
"description": "Sequential ID of this trade within Immutable X",
"description": "Sequential ID of this trade within ImmutableX",
"type": "integer"
}
}
Expand Down

0 comments on commit 35688b6

Please sign in to comment.