mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-16 18:35:50 +00:00
Compare commits
8 Commits
hooks
...
@transia/x
| Author | SHA1 | Date | |
|---|---|---|---|
|
78d1b9dc0f | ||
|
|
870eb86c96 | ||
|
|
fb898a5b30 | ||
|
|
ab343cf690 | ||
|
|
05bea18d66 | ||
|
|
a2576ab74a | ||
|
|
ef3f95475e | ||
|
|
25f267b81f |
120
package-lock.json
generated
120
package-lock.json
generated
@@ -2722,6 +2722,22 @@
|
||||
"node": ">= 6"
|
||||
}
|
||||
},
|
||||
"node_modules/@transia/ripple-address-codec": {
|
||||
"resolved": "packages/ripple-address-codec",
|
||||
"link": true
|
||||
},
|
||||
"node_modules/@transia/ripple-binary-codec": {
|
||||
"resolved": "packages/ripple-binary-codec",
|
||||
"link": true
|
||||
},
|
||||
"node_modules/@transia/ripple-keypairs": {
|
||||
"resolved": "packages/ripple-keypairs",
|
||||
"link": true
|
||||
},
|
||||
"node_modules/@transia/xrpl": {
|
||||
"resolved": "packages/xrpl",
|
||||
"link": true
|
||||
},
|
||||
"node_modules/@tsconfig/node10": {
|
||||
"version": "1.0.9",
|
||||
"resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz",
|
||||
@@ -17124,7 +17140,8 @@
|
||||
}
|
||||
},
|
||||
"packages/ripple-address-codec": {
|
||||
"version": "4.2.5",
|
||||
"name": "@transia/ripple-address-codec",
|
||||
"version": "4.2.6-alpha.0",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"base-x": "^3.0.9",
|
||||
@@ -17135,15 +17152,16 @@
|
||||
}
|
||||
},
|
||||
"packages/ripple-binary-codec": {
|
||||
"version": "1.4.3",
|
||||
"name": "@transia/ripple-binary-codec",
|
||||
"version": "1.4.4-alpha.1",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"assert": "^2.0.0",
|
||||
"big-integer": "^1.6.48",
|
||||
"buffer": "5.6.0",
|
||||
"create-hash": "^1.2.0",
|
||||
"decimal.js": "^10.2.0",
|
||||
"ripple-address-codec": "^4.2.5"
|
||||
"decimal.js": "^10.2.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 10"
|
||||
@@ -17158,31 +17176,33 @@
|
||||
}
|
||||
},
|
||||
"packages/ripple-keypairs": {
|
||||
"version": "1.1.5",
|
||||
"name": "@transia/ripple-keypairs",
|
||||
"version": "1.1.6-alpha.1",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"bn.js": "^5.1.1",
|
||||
"brorand": "^1.0.5",
|
||||
"elliptic": "^6.5.4",
|
||||
"hash.js": "^1.0.3",
|
||||
"ripple-address-codec": "^4.2.5"
|
||||
"hash.js": "^1.0.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 10"
|
||||
}
|
||||
},
|
||||
"packages/xrpl": {
|
||||
"version": "2.7.0",
|
||||
"name": "@transia/xrpl",
|
||||
"version": "2.7.1-alpha.4",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"@transia/ripple-binary-codec": "^1.4.4-alpha.1",
|
||||
"@transia/ripple-keypairs": "^1.1.6-alpha.1",
|
||||
"bignumber.js": "^9.0.0",
|
||||
"bip32": "^2.0.6",
|
||||
"bip39": "^3.0.4",
|
||||
"https-proxy-agent": "^5.0.0",
|
||||
"lodash": "^4.17.4",
|
||||
"ripple-address-codec": "^4.2.5",
|
||||
"ripple-binary-codec": "^1.4.3",
|
||||
"ripple-keypairs": "^1.1.5",
|
||||
"ws": "^8.2.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
@@ -19350,6 +19370,70 @@
|
||||
"integrity": "sha512-RbzJvlNzmRq5c3O09UipeuXno4tA1FE6ikOjxZK0tuxVv3412l64l5t1W5pj4+rJq9vpkm/kwiR07aZXnsKPxw==",
|
||||
"dev": true
|
||||
},
|
||||
"@transia/ripple-address-codec": {
|
||||
"version": "file:packages/ripple-address-codec",
|
||||
"requires": {
|
||||
"base-x": "^3.0.9",
|
||||
"create-hash": "^1.1.2"
|
||||
}
|
||||
},
|
||||
"@transia/ripple-binary-codec": {
|
||||
"version": "file:packages/ripple-binary-codec",
|
||||
"requires": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"assert": "^2.0.0",
|
||||
"big-integer": "^1.6.48",
|
||||
"buffer": "5.6.0",
|
||||
"create-hash": "^1.2.0",
|
||||
"decimal.js": "^10.2.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"buffer": {
|
||||
"version": "5.6.0",
|
||||
"requires": {
|
||||
"base64-js": "^1.0.2",
|
||||
"ieee754": "^1.1.4"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"@transia/ripple-keypairs": {
|
||||
"version": "file:packages/ripple-keypairs",
|
||||
"requires": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"bn.js": "^5.1.1",
|
||||
"brorand": "^1.0.5",
|
||||
"elliptic": "^6.5.4",
|
||||
"hash.js": "^1.0.3"
|
||||
}
|
||||
},
|
||||
"@transia/xrpl": {
|
||||
"version": "file:packages/xrpl",
|
||||
"requires": {
|
||||
"@geut/browser-node-core": "^2.0.13",
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"@transia/ripple-binary-codec": "^1.4.4-alpha.1",
|
||||
"@transia/ripple-keypairs": "^1.1.6-alpha.1",
|
||||
"@types/node": "^14.18.36",
|
||||
"assert-browserify": "^2.0.0",
|
||||
"bignumber.js": "^9.0.0",
|
||||
"bip32": "^2.0.6",
|
||||
"bip39": "^3.0.4",
|
||||
"browserify-fs": "^1.0.0",
|
||||
"constants-browserify": "^1.0.0",
|
||||
"https-browserify": "^1.0.0",
|
||||
"https-proxy-agent": "^5.0.0",
|
||||
"karma": "^6.4.1",
|
||||
"karma-chrome-launcher": "^3.1.1",
|
||||
"karma-jasmine": "^5.1.0",
|
||||
"karma-webpack": "^5.0.0",
|
||||
"lodash": "^4.17.4",
|
||||
"node-polyfill-webpack-plugin": "^2.0.1",
|
||||
"react": "^18.2.0",
|
||||
"typedoc": "^0.23.24",
|
||||
"ws": "^8.2.2"
|
||||
}
|
||||
},
|
||||
"@tsconfig/node10": {
|
||||
"version": "1.0.9",
|
||||
"resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz",
|
||||
@@ -28667,12 +28751,12 @@
|
||||
"ripple-binary-codec": {
|
||||
"version": "file:packages/ripple-binary-codec",
|
||||
"requires": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"assert": "^2.0.0",
|
||||
"big-integer": "^1.6.48",
|
||||
"buffer": "5.6.0",
|
||||
"create-hash": "^1.2.0",
|
||||
"decimal.js": "^10.2.0",
|
||||
"ripple-address-codec": "^4.2.5"
|
||||
"decimal.js": "^10.2.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"buffer": {
|
||||
@@ -28687,11 +28771,11 @@
|
||||
"ripple-keypairs": {
|
||||
"version": "file:packages/ripple-keypairs",
|
||||
"requires": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"bn.js": "^5.1.1",
|
||||
"brorand": "^1.0.5",
|
||||
"elliptic": "^6.5.4",
|
||||
"hash.js": "^1.0.3",
|
||||
"ripple-address-codec": "^4.2.5"
|
||||
"hash.js": "^1.0.3"
|
||||
}
|
||||
},
|
||||
"run-async": {
|
||||
@@ -30584,6 +30668,9 @@
|
||||
"version": "file:packages/xrpl",
|
||||
"requires": {
|
||||
"@geut/browser-node-core": "^2.0.13",
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"@transia/ripple-binary-codec": "^1.4.4-alpha.1",
|
||||
"@transia/ripple-keypairs": "^1.1.6-alpha.1",
|
||||
"@types/node": "^14.18.36",
|
||||
"assert-browserify": "^2.0.0",
|
||||
"bignumber.js": "^9.0.0",
|
||||
@@ -30600,9 +30687,6 @@
|
||||
"lodash": "^4.17.4",
|
||||
"node-polyfill-webpack-plugin": "^2.0.1",
|
||||
"react": "^18.2.0",
|
||||
"ripple-address-codec": "^4.2.5",
|
||||
"ripple-binary-codec": "^1.4.3",
|
||||
"ripple-keypairs": "^1.1.5",
|
||||
"typedoc": "^0.23.24",
|
||||
"ws": "^8.2.2"
|
||||
}
|
||||
|
||||
4
packages/ripple-address-codec/package-lock.json
generated
4
packages/ripple-address-codec/package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "ripple-address-codec",
|
||||
"version": "4.2.5",
|
||||
"version": "4.2.6-alpha.0",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "ripple-address-codec",
|
||||
"version": "4.2.4",
|
||||
"version": "4.2.6-alpha.0",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"base-x": "^3.0.9",
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
{
|
||||
"name": "@transia/ripple-address-codec",
|
||||
"version": "4.2.5",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"version": "4.2.6-alpha.0",
|
||||
"description": "encodes/decodes base58 encoded XRP Ledger identifiers",
|
||||
"files": [
|
||||
"dist/*",
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
{
|
||||
"name": "@transia/ripple-binary-codec",
|
||||
"version": "1.4.3",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"version": "1.4.4-alpha.1",
|
||||
"description": "XRP Ledger binary codec",
|
||||
"files": [
|
||||
"dist/*",
|
||||
@@ -12,12 +15,12 @@
|
||||
"test": "test"
|
||||
},
|
||||
"dependencies": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"assert": "^2.0.0",
|
||||
"big-integer": "^1.6.48",
|
||||
"buffer": "5.6.0",
|
||||
"create-hash": "^1.2.0",
|
||||
"decimal.js": "^10.2.0",
|
||||
"ripple-address-codec": "^4.2.5"
|
||||
"decimal.js": "^10.2.0"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsc -b && copyfiles ./src/enums/definitions.json ./dist/enums/",
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
{
|
||||
"name": "@transia/ripple-keypairs",
|
||||
"version": "1.1.5",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"version": "1.1.6-alpha.1",
|
||||
"description": "Cryptographic key pairs for the XRP Ledger",
|
||||
"scripts": {
|
||||
"build": "tsc -b",
|
||||
@@ -17,11 +20,11 @@
|
||||
"test": "test"
|
||||
},
|
||||
"dependencies": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"bn.js": "^5.1.1",
|
||||
"brorand": "^1.0.5",
|
||||
"elliptic": "^6.5.4",
|
||||
"hash.js": "^1.0.3",
|
||||
"ripple-address-codec": "^4.2.5"
|
||||
"hash.js": "^1.0.3"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
{
|
||||
"name": "@transia/xrpl",
|
||||
"version": "2.7.0",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"version": "2.7.1-alpha.4",
|
||||
"license": "ISC",
|
||||
"description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
|
||||
"files": [
|
||||
@@ -22,14 +25,14 @@
|
||||
"https-proxy-agent": false
|
||||
},
|
||||
"dependencies": {
|
||||
"@transia/ripple-address-codec": "^4.2.6-alpha.0",
|
||||
"@transia/ripple-binary-codec": "^1.4.4-alpha.1",
|
||||
"@transia/ripple-keypairs": "^1.1.6-alpha.1",
|
||||
"bignumber.js": "^9.0.0",
|
||||
"bip32": "^2.0.6",
|
||||
"bip39": "^3.0.4",
|
||||
"https-proxy-agent": "^5.0.0",
|
||||
"lodash": "^4.17.4",
|
||||
"ripple-address-codec": "^4.2.5",
|
||||
"ripple-binary-codec": "^1.4.3",
|
||||
"ripple-keypairs": "^1.1.5",
|
||||
"ws": "^8.2.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
||||
@@ -47,3 +47,12 @@ export { SetHook } from './setHook'
|
||||
export { SignerListSet } from './signerListSet'
|
||||
export { TicketCreate } from './ticketCreate'
|
||||
export { TrustSetFlagsInterface, TrustSetFlags, TrustSet } from './trustSet'
|
||||
export {
|
||||
URITokenMintFlagsInterface,
|
||||
URITokenMintFlags,
|
||||
URITokenMint,
|
||||
} from './uriTokenMint'
|
||||
export { URITokenBurn } from './uriTokenBurn'
|
||||
export { URITokenCreateSellOffer } from './uriTokenCreateSellOffer'
|
||||
export { URITokenBuy } from './uriTokenBuy'
|
||||
export { URITokenCancelSellOffer } from './uriTokenCancelSellOffer'
|
||||
|
||||
@@ -48,6 +48,17 @@ import { SetRegularKey, validateSetRegularKey } from './setRegularKey'
|
||||
import { SignerListSet, validateSignerListSet } from './signerListSet'
|
||||
import { TicketCreate, validateTicketCreate } from './ticketCreate'
|
||||
import { TrustSet, validateTrustSet } from './trustSet'
|
||||
import { URITokenBurn, validateURITokenBurn } from './uriTokenBurn'
|
||||
import { URITokenBuy, validateURITokenBuy } from './uriTokenBuy'
|
||||
import {
|
||||
URITokenCancelSellOffer,
|
||||
validateURITokenCancelSellOffer,
|
||||
} from './uriTokenCancelSellOffer'
|
||||
import {
|
||||
URITokenCreateSellOffer,
|
||||
validateURITokenCreateSellOffer,
|
||||
} from './uriTokenCreateSellOffer'
|
||||
import { URITokenMint, validateURITokenMint } from './uriTokenMint'
|
||||
|
||||
/**
|
||||
* @category Transaction Models
|
||||
@@ -78,6 +89,11 @@ export type Transaction =
|
||||
| SignerListSet
|
||||
| TicketCreate
|
||||
| TrustSet
|
||||
| URITokenBurn
|
||||
| URITokenBuy
|
||||
| URITokenCancelSellOffer
|
||||
| URITokenMint
|
||||
| URITokenCreateSellOffer
|
||||
|
||||
/**
|
||||
* @category Transaction Models
|
||||
@@ -206,6 +222,26 @@ export function validate(transaction: Record<string, unknown>): void {
|
||||
validateTrustSet(tx)
|
||||
break
|
||||
|
||||
case 'URITokenMint':
|
||||
validateURITokenMint(tx)
|
||||
break
|
||||
|
||||
case 'URITokenBurn':
|
||||
validateURITokenBurn(tx)
|
||||
break
|
||||
|
||||
case 'URITokenCreateSellOffer':
|
||||
validateURITokenCreateSellOffer(tx)
|
||||
break
|
||||
|
||||
case 'URITokenBuy':
|
||||
validateURITokenBuy(tx)
|
||||
break
|
||||
|
||||
case 'URITokenCancelSellOffer':
|
||||
validateURITokenCancelSellOffer(tx)
|
||||
break
|
||||
|
||||
default:
|
||||
throw new ValidationError(
|
||||
`Invalid field TransactionType: ${tx.TransactionType}`,
|
||||
|
||||
60
packages/xrpl/src/models/transactions/uriTokenBurn.ts
Normal file
60
packages/xrpl/src/models/transactions/uriTokenBurn.ts
Normal file
@@ -0,0 +1,60 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenBurn} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenBurn = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* TransactionType: 'URITokenBurn',
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* // TransactionType: 'URITokenBurn',
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
|
||||
/**
|
||||
* An URITokenBurn transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenBurn extends BaseTransaction {
|
||||
TransactionType: 'URITokenBurn'
|
||||
/**
|
||||
* Identifies the URIToken object to be removed by the transaction.
|
||||
*/
|
||||
URITokenID: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenBurn at runtime.
|
||||
*
|
||||
* @param tx - An URITokenBurn Transaction.
|
||||
* @throws When the URITokenBurn is Malformed.
|
||||
*/
|
||||
export function validateURITokenBurn(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (tx.URITokenID == null) {
|
||||
throw new ValidationError('NFTokenBurn: missing field URITokenID')
|
||||
}
|
||||
}
|
||||
83
packages/xrpl/src/models/transactions/uriTokenBuy.ts
Normal file
83
packages/xrpl/src/models/transactions/uriTokenBuy.ts
Normal file
@@ -0,0 +1,83 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Amount } from '../common'
|
||||
|
||||
import { BaseTransaction, isAmount, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenBuy} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenBuy = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* Amount: '1000000',
|
||||
* TransactionType: 'URITokenBuy',
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* // Amount: '1000000',
|
||||
* // TransactionType: 'URITokenBuy',
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
|
||||
/**
|
||||
* An URITokenBuy transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenBuy extends BaseTransaction {
|
||||
TransactionType: 'URITokenBuy'
|
||||
/**
|
||||
* Identifies the URITokenID of the NFToken object that the
|
||||
* offer references.
|
||||
*/
|
||||
URITokenID: string
|
||||
/**
|
||||
* Indicates the amount expected or offered for the Token.
|
||||
*
|
||||
* The amount must be non-zero, except when this is a sell
|
||||
* offer and the asset is XRP. This would indicate that the current
|
||||
* owner of the token is giving it away free, either to anyone at all,
|
||||
* or to the account identified by the Destination field.
|
||||
*/
|
||||
Amount: Amount
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenBuy at runtime.
|
||||
*
|
||||
* @param tx - An URITokenBuy Transaction.
|
||||
* @throws When the URITokenBuy is Malformed.
|
||||
*/
|
||||
export function validateURITokenBuy(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (tx.Account === tx.Destination) {
|
||||
throw new ValidationError(
|
||||
'URITokenBuy: Destination and Account must not be equal',
|
||||
)
|
||||
}
|
||||
|
||||
if (tx.URITokenID == null) {
|
||||
throw new ValidationError('URITokenBuy: missing field URITokenID')
|
||||
}
|
||||
|
||||
if (!isAmount(tx.Amount)) {
|
||||
throw new ValidationError('URITokenBuy: invalid Amount')
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,65 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenCancelSellOffer} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenCancelSellOffer = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* TransactionType: 'URITokenCancelSellOffer',
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* // TransactionType: 'URITokenCancelSellOffer',
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
|
||||
/**
|
||||
* An URITokenCancelSellOffer transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenCancelSellOffer extends BaseTransaction {
|
||||
TransactionType: 'URITokenCancelSellOffer'
|
||||
/**
|
||||
* Identifies the URITokenID of the NFToken object that the
|
||||
* offer references.
|
||||
*/
|
||||
URITokenID: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenCancelSellOffer at runtime.
|
||||
*
|
||||
* @param tx - An URITokenCancelSellOffer Transaction.
|
||||
* @throws When the URITokenCancelSellOffer is Malformed.
|
||||
*/
|
||||
export function validateURITokenCancelSellOffer(
|
||||
tx: Record<string, unknown>,
|
||||
): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (tx.URITokenID == null) {
|
||||
throw new ValidationError(
|
||||
'URITokenCancelSellOffer: missing field URITokenID',
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Amount } from '../common'
|
||||
|
||||
import { BaseTransaction, isAmount, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenCreateSellOffer} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenCreateSellOffer = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* Amount: '1000000',
|
||||
* TransactionType: 'URITokenCreateSellOffer',
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* // Amount: '1000000',
|
||||
* // TransactionType: 'URITokenCreateSellOffer',
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
|
||||
/**
|
||||
* An URITokenCreateSellOffer transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenCreateSellOffer extends BaseTransaction {
|
||||
TransactionType: 'URITokenCreateSellOffer'
|
||||
/**
|
||||
* Identifies the URITokenID of the NFToken object that the
|
||||
* offer references.
|
||||
*/
|
||||
URITokenID: string
|
||||
/**
|
||||
* Indicates the amount expected or offered for the Token.
|
||||
*
|
||||
* The amount must be non-zero, except when this is a sell
|
||||
* offer and the asset is XRP. This would indicate that the current
|
||||
* owner of the token is giving it away free, either to anyone at all,
|
||||
* or to the account identified by the Destination field.
|
||||
*/
|
||||
Amount: Amount
|
||||
/**
|
||||
* If present, indicates that this offer may only be
|
||||
* accepted by the specified account. Attempts by other
|
||||
* accounts to accept this offer MUST fail.
|
||||
*/
|
||||
Destination?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenCreateSellOffer at runtime.
|
||||
*
|
||||
* @param tx - An URITokenCreateSellOffer Transaction.
|
||||
* @throws When the URITokenCreateSellOffer is Malformed.
|
||||
*/
|
||||
export function validateURITokenCreateSellOffer(
|
||||
tx: Record<string, unknown>,
|
||||
): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (tx.Account === tx.Destination) {
|
||||
throw new ValidationError(
|
||||
'URITokenCreateSellOffer: Destination and Account must not be equal',
|
||||
)
|
||||
}
|
||||
|
||||
if (tx.URITokenID == null) {
|
||||
throw new ValidationError(
|
||||
'URITokenCreateSellOffer: missing field URITokenID',
|
||||
)
|
||||
}
|
||||
|
||||
if (!isAmount(tx.Amount)) {
|
||||
throw new ValidationError('URITokenCreateSellOffer: invalid Amount')
|
||||
}
|
||||
}
|
||||
92
packages/xrpl/src/models/transactions/uriTokenMint.ts
Normal file
92
packages/xrpl/src/models/transactions/uriTokenMint.ts
Normal file
@@ -0,0 +1,92 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { isHex } from '../utils'
|
||||
|
||||
import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Transaction Flags for an URITokenMint Transaction.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*/
|
||||
export enum URITokenMintFlags {
|
||||
/**
|
||||
* If set, indicates that the minted token may be burned by the issuer even
|
||||
* if the issuer does not currently hold the token. The current holder of
|
||||
* the token may always burn it.
|
||||
*/
|
||||
tfBurnable = 0x00000001,
|
||||
}
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenMint} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenMint = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URI: '697066733A2F2F434944',
|
||||
* TransactionType: 'URITokenMint',
|
||||
* Flags: {
|
||||
* tfBurnable: true,
|
||||
* },
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URI: '697066733A2F2F434944',
|
||||
* // TransactionType: 'URITokenMint',
|
||||
* // Flags: 0,
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
export interface URITokenMintFlagsInterface extends GlobalFlags {
|
||||
tfBurnable?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* An URITokenMint transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenMint extends BaseTransaction {
|
||||
TransactionType: 'URITokenMint'
|
||||
Flags?: number | URITokenMintFlagsInterface
|
||||
/**
|
||||
* URI that points to the data and/or metadata associated with the NFT.
|
||||
* This field need not be an HTTP or HTTPS URL; it could be an IPFS URI, a
|
||||
* magnet link, immediate data encoded as an RFC2379 "data" URL, or even an
|
||||
* opaque issuer-specific encoding. The URI is NOT checked for validity, but
|
||||
* the field is limited to a maximum length of 256 bytes.
|
||||
*
|
||||
* This field must be hex-encoded. You can use `convertStringToHex` to
|
||||
* convert this field to the proper encoding.
|
||||
*/
|
||||
URI: string
|
||||
|
||||
Digest?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenMint at runtime.
|
||||
*
|
||||
* @param tx - An URITokenMint Transaction.
|
||||
* @throws When the URITokenMint is Malformed.
|
||||
*/
|
||||
export function validateURITokenMint(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (typeof tx.URI === 'string' && !isHex(tx.URI)) {
|
||||
throw new ValidationError('URITokenMint: URI must be in hex format')
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user