Dev:API - Finance - Revision history

Nexus wiki at 23:32, 6 October 2024

2024-10-06T23:32:07Z

@@ Line 7: / Line 7: @@
   finance/verb/noun
-= Direct Endpoints =
+= Endpoints =
-The following commands are direct endpoints not using the supported nouns and verbs:
+== finance/get/balances ==
   finance/get/balances
   finance/get/stakeinfo
   finance/set/stake
   finance/void/transaction
   finance/migrate/accounts

Nexus wiki at 23:22, 6 October 2024

2024-10-06T23:22:04Z

← Older revision		Revision as of 23:22, 6 October 2024
Line 17:		Line 17:
	finance/migrate/accounts		finance/migrate/accounts

	== Supported Nouns ==		= Supported Nouns =

	The following nouns are supported for this API command-set:		The following nouns are supported for this API command-set:
Line 35:		Line 35:
	\|}		\|}

	== Supported Verbs ==		= Supported Verbs =

	The following verbs are currently supported by this command-set:		The following verbs are currently supported by this command-set:
Line 59:		Line 59:
	\|}		\|}

	== Verbs ==		= Verbs =

	=== burn ===		=== burn ===

Nexus wiki at 23:20, 6 October 2024

2024-10-06T23:20:59Z

← Older revision		Revision as of 23:20, 6 October 2024
Line 7:		Line 7:
	finance/verb/noun		finance/verb/noun

	== Direct Endpoints ==		= Direct Endpoints =

	The following commands are direct endpoints not using the supported nouns and verbs:		The following commands are direct endpoints not using the supported nouns and verbs:

Nexus wiki at 23:19, 6 October 2024

2024-10-06T23:19:51Z

Show changes

Nexus wiki: /* Return Values */

2024-10-06T22:26:30Z

Return Values

← Older revision		Revision as of 22:26, 6 October 2024
Line 368:		Line 368:
	\| token \|\| Register address of the token. Set to 0 for NXS accounts.		\| token \|\| Register address of the token. Set to 0 for NXS accounts.
	\|-		\|-
	\| trust \| Trust score of the trust account		\| trust \|\| Trust score of the trust account
	\|-		\|-
	\| type \|\| The type of register. Can be OBJECT, RAW or READONLY		\| type \|\| The type of register. Can be OBJECT, RAW or READONLY

Nexus wiki: /* Return Values */

2024-10-06T22:25:57Z

Return Values

← Older revision		Revision as of 22:25, 6 October 2024
Line 288:		Line 288:
	\| token \|\| Register address of the token. Set to 0 for NXS accounts.		\| token \|\| Register address of the token. Set to 0 for NXS accounts.
	\|-		\|-
	\| trust \| Trust score of the trust account		\| trust \|\| Trust score of the trust account
	\|-		\|-
	\| type \|\| The type of register. Can be OBJECT, RAW or READONLY		\| type \|\| The type of register. Can be OBJECT, RAW or READONLY

Nexus wiki at 22:25, 6 October 2024

2024-10-06T22:25:17Z

← Older revision		Revision as of 22:25, 6 October 2024
Line 312:		Line 312:
	"address": "8EunQ82qVdnuQkX2gXKZr5P55kQRz4KbpaLdCVBjBNu8jeys4C4"		"address": "8EunQ82qVdnuQkX2gXKZr5P55kQRz4KbpaLdCVBjBNu8jeys4C4"
	}		}

			=== history ===

			This will get the history of the specified noun.

			finance/history/noun

			This command supports the account, trust and token nouns.

			==== Parameters ====

			{\| class="wikitable"
			! Name !! Description !! Required
			\|-
			\| address \|\| register address of the asset \|\| Required if name is not provided
			\|-
			\| name \|\| In the format username:name (for local names) or namespace::name (for names in a namespace). If you are logged in, the username: field is not required. \|\| Required if address is not provided
			\|-
			\| session \|\| User session ID \|\| Required if argument -multiuser=1 is set
			\|}

			==== Return Values ====

			{\| class="wikitable"
			! Name !! Description
			\|-
			\| action \|\| The action that occurred - CREATE \| MODIFY \| TRANSFER \| CLAIM.
			\|-
			\| address \|\| Register address that has been retrieved
			\|-
			\| age \|\| Age of the trust account in the format "(x) days, (x) hours, (x) minutes"
			\|-
			\| balance \|\| The available balance of this account. This is the last confirmed balance added to any new debits made since the last block.
			\|-
			\| created \|\| UNIX timestamp when the account was created
			\|-
			\| currentsupply \|\| Amount of tokens that have been distributed to token accounts
			\|-
			\| decimals \|\| Maximum number of decimal places that can be applied to token amounts
			\|-
			\| maxsupply \|\| Maximum token supply amount
			\|-
			\| modified \|\| UNIX timestamp when the account was last modified
			\|-
			\| name \|\| Name identifying the account, trust or token
			\|-
			\| owner \|\| Genesis hash of the profile that owns the object
			\|-
			\| rate \|\| Current annual percentage reward rate from staking
			\|-
			\| stake \|\| Amount of NXS currently staked in a trust account
			\|-
			\| ticker \|\| Name of the token object. For NXS accounts will show NXS.
			\|-
			\| token \|\| Register address of the token. Set to 0 for NXS accounts.
			\|-
			\| trust \| Trust score of the trust account
			\|-
			\| type \|\| The type of register. Can be OBJECT, RAW or READONLY
			\|-
			\| version \|\| The serialization version of the transaction
			\|}

			==== Example Response JSON ====

			[
			{
			"owner": "b7fa11647c02a3a65a72970d8e703d8804eb127c7e7c41d565c3514a4d3fdf13",
			"version": 1,
			"created": 1654808903,
			"modified": 1654809207,
			"type": "OBJECT",
			"balance": 1000.0,
			"token": "8DXmAmkTtysSZUxM3ePA8wRmbSUofuHKSoCyDpN28aLuSrm1nDG",
			"ticker": "XYZ",
			"address": "8Bk5PxsecfXWpbHsDXeZ47MCgDF7qDLsU4Y4MJw2VB29LsTR98z",
			"name": "local:XYZToken",
			"action": "CREDIT"
			},
			{
			"owner": "b7fa11647c02a3a65a72970d8e703d8804eb127c7e7c41d565c3514a4d3fdf13",
			"version": 1,
			"created": 1654808903,
			"modified": 1654808903,
			"type": "OBJECT",
			"balance": 0.0,
			"token": "8DXmAmkTtysSZUxM3ePA8wRmbSUofuHKSoCyDpN28aLuSrm1nDG",
			"ticker": "XYZ",
			"address": "8Bk5PxsecfXWpbHsDXeZ47MCgDF7qDLsU4Y4MJw2VB29LsTR98z",
			"name": "local:XYZToken",
			"action": "CREATE"
			}
			]

Nexus wiki at 22:08, 6 October 2024

2024-10-06T22:08:27Z

@@ Line 92: / Line 92: @@
 ! Name !! Description
 |-
-| address || Register address for this account. The address (or name that hashes to this address) is needed when creating crediting or debiting the account.
+| address || Register address
 |-
-| success || Boolean flag indicating that the debit was successful
+| success || Boolean flag indicating that the burn was successful
 |-
 | txid || The hash of the transaction that was generated for this tx. If using -autotx this field will be omitted.
@@ Line 235: / Line 235: @@
     "success": true,
     "txid": "01f51d6b23b871fc8da848afa57cf066cb9e3b8fb845a666335e8c678ef5249e98d4f3e477659098918e4bb590472a63d0ed0a17fa87904fcff6316158e9edfd"
+  }

Nexus wiki at 20:37, 6 October 2024

2024-10-06T20:37:54Z

@@ Line 153: / Line 153: @@
     "address": "8ESvYizqdApiuKEBjZMF1hnB8asDqECaDwAstcH3UtJ4Z6ceCn2",
     "txid": "0131e17af8029b414814283a3d90813d12c238db6ddab213440249b795090a9cd77079d5804ec38303a59414d87108d4e44bf31f54a6c176285281a88ab5d737"
+  }

Nexus wiki at 19:16, 6 October 2024

2024-10-06T19:16:55Z

@@ Line 105: / Line 105: @@
     "address": "8BfLgEprhbHs82LxUkJR9jhQufRZf49g73Nt8XTGevfiyy7ijhb",
     "txid": "01854fe4fdf0d59aebb3a880141484f0542af061cbebfd468db3fcecd13f63a986d990cf669ca4a60822a82b2d4fc7e7e474801a01bff86a35fd0a147a5a62da"
+  }