Skip to content

Commit

Permalink
Regenerated TS SDK
Browse files Browse the repository at this point in the history
  • Loading branch information
krzlabrdx committed May 9, 2024
1 parent 27b2b1f commit ef7ed0d
Show file tree
Hide file tree
Showing 54 changed files with 189 additions and 288 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -124,24 +124,21 @@ export interface CommittedTransactionInfo {
receipt?: TransactionReceipt;
/**
* A text-representation of a transaction manifest.
This field will be present only for user transactions and when explicitly opted-in using `manifest_instructions` flag.
* This field will be present only for user transactions and when explicitly opted-in using `manifest_instructions` flag.
* @type {string}
* @memberof CommittedTransactionInfo
*/
manifest_instructions?: string | null;
/**
* A collection of zero or more manifest classes ordered from the most specific class to the least specific one.
This field will be present only for user transactions.
* This field will be present only for user transactions.
* @type {Array<ManifestClass>}
* @memberof CommittedTransactionInfo
*/
manifest_classes?: Array<ManifestClass> | null;
/**
* The optional transaction message.
This type is defined in the Core API as `TransactionMessage`. See the Core API documentation for more details.
* This type is defined in the Core API as `TransactionMessage`. See the Core API documentation for more details.
* @type {object}
* @memberof CommittedTransactionInfo
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ export interface ComponentEntityRoleAssignmentEntryAssignment {
resolution: RoleAssignmentResolution;
/**
* This type is defined in the Core API as `AccessRule`. See the Core API documentation for more details.
* @type {object}
* @memberof ComponentEntityRoleAssignmentEntryAssignment
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import {
export interface ComponentEntityRoleAssignments {
/**
* This type is defined in the Core API as `OwnerRole`. See the Core API documentation for more details.
* @type {object}
* @memberof ComponentEntityRoleAssignments
*/
Expand Down
1 change: 0 additions & 1 deletion sdk/typescript/lib/generated/models/EventsItem.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ export interface EventsItem {
name: string;
/**
* This type is defined in the Core API as `EventEmitterIdentifier`. See the Core API documentation for more details.
* @type {object}
* @memberof EventsItem
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import { exists, mapValues } from '../runtime';
export interface GatewayInfoResponseKnownTarget {
/**
* The latest-seen state version of the tip of the network's ledger. If this is significantly ahead of the current ledger state version, the Network Gateway is possibly behind and may be reporting outdated information.
* @type {number}
* @memberof GatewayInfoResponseKnownTarget
*/
Expand Down
10 changes: 4 additions & 6 deletions sdk/typescript/lib/generated/models/LedgerState.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@
import { exists, mapValues } from '../runtime';
/**
* The ledger state against which the response was generated.
Can be used to detect if the Network Gateway is returning up-to-date information.
* Can be used to detect if the Network Gateway is returning up-to-date information.
* @export
* @interface LedgerState
*/
Expand All @@ -35,10 +34,9 @@ export interface LedgerState {
state_version: number;
/**
* The proposer round timestamp of the consensus round when this transaction was committed to ledger.
This is not guaranteed to be strictly increasing, as it is computed as an average across the validator set.
If this is significantly behind the current timestamp, the Network Gateway is likely reporting out-dated
information, or the network has stalled.
* This is not guaranteed to be strictly increasing, as it is computed as an average across the validator set.
* If this is significantly behind the current timestamp, the Network Gateway is likely reporting out-dated
* information, or the network has stalled.
* @type {string}
* @memberof LedgerState
*/
Expand Down
5 changes: 2 additions & 3 deletions sdk/typescript/lib/generated/models/LedgerStateSelector.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@
import { exists, mapValues } from '../runtime';
/**
* Optional. This allows for a request to be made against a historic state.
If a constraint is specified, the Gateway will resolve the request against the ledger state at that time.
If not specified, requests will be made with respect to the top of the committed ledger.
* If a constraint is specified, the Gateway will resolve the request against the ledger state at that time.
* If not specified, requests will be made with respect to the top of the committed ledger.
* @export
* @interface LedgerStateSelector
*/
Expand Down
17 changes: 8 additions & 9 deletions sdk/typescript/lib/generated/models/ManifestClass.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,14 @@

/**
* High-level manifest class type:
* `General`: A general manifest that involves any amount of arbitrary components and packages where nothing more concrete can be said about the manifest and its nature.
* `Transfer`: A manifest of a 1-to-1 transfer to a one-to-many transfer of resources.
* `PoolContribution`: A manifest that contributed some amount of resources to a liquidity pool that can be a one-resource pool, two-resource pool, or a multi-resource pool.
* `PoolRedemption`: A manifest that redeemed resources from a liquidity pool. Similar to contributions, this can be any of the three pool blueprints available in the pool package.
* `ValidatorStake`: A manifest where XRD is staked to one or more validators.
* `ValidatorUnstake`: A manifest where XRD is unstaked from one or more validators.
* `ValidatorClaim`: A manifest where XRD is claimed from one or more validators.
* `AccountDepositSettingsUpdate`: A manifest that updated the deposit settings of the account.
* * `General`: A general manifest that involves any amount of arbitrary components and packages where nothing more concrete can be said about the manifest and its nature.
* * `Transfer`: A manifest of a 1-to-1 transfer to a one-to-many transfer of resources.
* * `PoolContribution`: A manifest that contributed some amount of resources to a liquidity pool that can be a one-resource pool, two-resource pool, or a multi-resource pool.
* * `PoolRedemption`: A manifest that redeemed resources from a liquidity pool. Similar to contributions, this can be any of the three pool blueprints available in the pool package.
* * `ValidatorStake`: A manifest where XRD is staked to one or more validators.
* * `ValidatorUnstake`: A manifest where XRD is unstaked from one or more validators.
* * `ValidatorClaim`: A manifest where XRD is claimed from one or more validators.
* * `AccountDepositSettingsUpdate`: A manifest that updated the deposit settings of the account.
* @export
*/
export const ManifestClass = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
import { exists, mapValues } from '../runtime';
/**
* See documentation of `MetadataInstantValue` for detailed description of `values` vs `values_unix_timestamp_seconds`.
* @export
* @interface MetadataInstantArrayValueAllOf
*/
Expand Down
12 changes: 5 additions & 7 deletions sdk/typescript/lib/generated/models/MetadataInstantValue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,17 @@ export interface MetadataInstantValue {
type: MetadataInstantValueTypeEnum;
/**
* The RFC 3339 / ISO 8601 string representation of the timestamp. Will always use "Z" (denoting UTC) and omits milliseconds. E.g.: `2023-01-26T18:30:09Z`.
Note: This field will return clamped value if the actual on-ledger `unix_timestamp_seconds` value is outside the basic range supported by the RFC 3339 / ISO 8601 standard,
which starts at year 1583 (i.e. the beginning of the Gregorian calendar) and ends at year 9999 (inclusive).
*
* Note: This field will return clamped value if the actual on-ledger `unix_timestamp_seconds` value is outside the basic range supported by the RFC 3339 / ISO 8601 standard,
* which starts at year 1583 (i.e. the beginning of the Gregorian calendar) and ends at year 9999 (inclusive).
* @type {string}
* @memberof MetadataInstantValue
*/
value: string;
/**
* A decimal string-encoded 64-bit signed integer, marking the unix timestamp in seconds.
Note: this field accurately represents the full range of possible on-ledger values (i.e. `-2^63 <= seconds < 2^63`).
*
* Note: this field accurately represents the full range of possible on-ledger values (i.e. `-2^63 <= seconds < 2^63`).
* @type {string}
* @memberof MetadataInstantValue
*/
Expand Down
12 changes: 5 additions & 7 deletions sdk/typescript/lib/generated/models/MetadataInstantValueAllOf.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,17 @@ import { exists, mapValues } from '../runtime';
export interface MetadataInstantValueAllOf {
/**
* The RFC 3339 / ISO 8601 string representation of the timestamp. Will always use "Z" (denoting UTC) and omits milliseconds. E.g.: `2023-01-26T18:30:09Z`.
Note: This field will return clamped value if the actual on-ledger `unix_timestamp_seconds` value is outside the basic range supported by the RFC 3339 / ISO 8601 standard,
which starts at year 1583 (i.e. the beginning of the Gregorian calendar) and ends at year 9999 (inclusive).
*
* Note: This field will return clamped value if the actual on-ledger `unix_timestamp_seconds` value is outside the basic range supported by the RFC 3339 / ISO 8601 standard,
* which starts at year 1583 (i.e. the beginning of the Gregorian calendar) and ends at year 9999 (inclusive).
* @type {string}
* @memberof MetadataInstantValueAllOf
*/
value: string;
/**
* A decimal string-encoded 64-bit signed integer, marking the unix timestamp in seconds.
Note: this field accurately represents the full range of possible on-ledger values (i.e. `-2^63 <= seconds < 2^63`).
*
* Note: this field accurately represents the full range of possible on-ledger values (i.e. `-2^63 <= seconds < 2^63`).
* @type {string}
* @memberof MetadataInstantValueAllOf
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ export interface PackageBlueprintCollectionItem {
version: string;
/**
* This type is defined in the Core API as `BlueprintDefinition`. See the Core API documentation for more details.
* @type {object}
* @memberof PackageBlueprintCollectionItem
*/
Expand All @@ -53,7 +52,6 @@ export interface PackageBlueprintCollectionItem {
dependant_entities?: Array<string>;
/**
* This type is defined in the Core API as `AuthConfig`. See the Core API documentation for more details.
* @type {object}
* @memberof PackageBlueprintCollectionItem
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,16 @@ export interface ProgrammaticScryptoSborValueArray {
kind: ProgrammaticScryptoSborValueArrayKindEnum;
/**
* The name of the type of this value.
This is only output when a schema is present and the type has a name.
This property is ignored when the value is used as an input to the API.
* This is only output when a schema is present and the type has a name.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueArray
*/
type_name?: string | null;
/**
* The name of the field which hosts this value.
This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
This property is ignored when the value is used as an input to the API.
* This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueArray
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,37 +22,36 @@ import {

/**
* Arbitrary SBOR value represented as programmatic JSON with optional property name annotations.
All scalar types (`Bool`, `I*`, `U*`, `String`, `Reference`, `Own`, `Decimal`, `PreciseDecimal`, `NonFungibleLocalId`)
convey their value via `value` string property with notable exception of `Bool` type that uses regular JSON boolean type.
Numeric values as string-encoded to preserve accuracy and simplify implementation on platforms with no native support
for 64-bit long numerical values.
Common properties represented as nullable strings:
* `type_name` is only output when a schema is present and the type has a name,
* `field_name` is only output when the value is a child of a `Tuple` or `Enum`, which has a type with named fields,
* `variant_name` is only output when a schema is present and the type is an `Enum`.
The following is a non-normative example annotated `Tuple` value with `String` and `U32` fields:
```
{
"kind": "Tuple",
"type_name": "CustomStructure",
"fields": [
{
"kind": "String",
"field_name": "favorite_color",
"value": "Blue"
},
{
"kind": "U32",
"field_name": "usage_counter",
"value": "462231"
}
]
}
```
*
* All scalar types (`Bool`, `I*`, `U*`, `String`, `Reference`, `Own`, `Decimal`, `PreciseDecimal`, `NonFungibleLocalId`)
* convey their value via `value` string property with notable exception of `Bool` type that uses regular JSON boolean type.
* Numeric values as string-encoded to preserve accuracy and simplify implementation on platforms with no native support
* for 64-bit long numerical values.
*
* Common properties represented as nullable strings:
* * `type_name` is only output when a schema is present and the type has a name,
* * `field_name` is only output when the value is a child of a `Tuple` or `Enum`, which has a type with named fields,
* * `variant_name` is only output when a schema is present and the type is an `Enum`.
*
* The following is a non-normative example annotated `Tuple` value with `String` and `U32` fields:
* ```
* {
* "kind": "Tuple",
* "type_name": "CustomStructure",
* "fields": [
* {
* "kind": "String",
* "field_name": "favorite_color",
* "value": "Blue"
* },
* {
* "kind": "U32",
* "field_name": "usage_counter",
* "value": "462231"
* }
* ]
* }
* ```
* @export
* @interface ProgrammaticScryptoSborValueBase
*/
Expand All @@ -65,18 +64,16 @@ export interface ProgrammaticScryptoSborValueBase {
kind: ProgrammaticScryptoSborValueKind;
/**
* The name of the type of this value.
This is only output when a schema is present and the type has a name.
This property is ignored when the value is used as an input to the API.
* This is only output when a schema is present and the type has a name.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueBase
*/
type_name?: string | null;
/**
* The name of the field which hosts this value.
This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
This property is ignored when the value is used as an input to the API.
* This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueBase
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,16 @@ export interface ProgrammaticScryptoSborValueBool {
kind: ProgrammaticScryptoSborValueBoolKindEnum;
/**
* The name of the type of this value.
This is only output when a schema is present and the type has a name.
This property is ignored when the value is used as an input to the API.
* This is only output when a schema is present and the type has a name.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueBool
*/
type_name?: string | null;
/**
* The name of the field which hosts this value.
This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
This property is ignored when the value is used as an input to the API.
* This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueBool
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,16 @@ export interface ProgrammaticScryptoSborValueBytes {
kind: ProgrammaticScryptoSborValueBytesKindEnum;
/**
* The name of the type of this value.
This is only output when a schema is present and the type has a name.
This property is ignored when the value is used as an input to the API.
* This is only output when a schema is present and the type has a name.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueBytes
*/
type_name?: string | null;
/**
* The name of the field which hosts this value.
This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
This property is ignored when the value is used as an input to the API.
* This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueBytes
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,16 @@ export interface ProgrammaticScryptoSborValueDecimal {
kind: ProgrammaticScryptoSborValueDecimalKindEnum;
/**
* The name of the type of this value.
This is only output when a schema is present and the type has a name.
This property is ignored when the value is used as an input to the API.
* This is only output when a schema is present and the type has a name.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueDecimal
*/
type_name?: string | null;
/**
* The name of the field which hosts this value.
This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
This property is ignored when the value is used as an input to the API.
* This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueDecimal
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,16 @@ export interface ProgrammaticScryptoSborValueEnum {
kind: ProgrammaticScryptoSborValueEnumKindEnum;
/**
* The name of the type of this value.
This is only output when a schema is present and the type has a name.
This property is ignored when the value is used as an input to the API.
* This is only output when a schema is present and the type has a name.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueEnum
*/
type_name?: string | null;
/**
* The name of the field which hosts this value.
This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
This property is ignored when the value is used as an input to the API.
* This property is only included if this value is a child of a `Tuple` or `Enum` with named fields.
* This property is ignored when the value is used as an input to the API.
* @type {string}
* @memberof ProgrammaticScryptoSborValueEnum
*/
Expand Down
Loading

0 comments on commit ef7ed0d

Please sign in to comment.