Download OpenAPI specification:Download
API reference for the Freight Trust dApp which allows recording, transfering and signing of EDI-based documents such as bills of lading or warehouse receipts.
Sets address that is delegate called to run a function's logic. This function must be called with an signed nonce from the Freight Trust account in the https body.
|
id
required
|
string
10 characters
Function selector whose target to change. |
|
target
required
|
string
42 characters
The address to set the function too |
The Freight Trust signature of the nonce
|
signature
required
|
string
132 characters
|
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
Sets address that is delegate called to run a function's logic. This function must be called with an signed nonce from the Freight Trust account in the https body.
|
newMaster
required
|
string
42 characters
The new master address |
The Freight Trust signature of the nonce
|
signature
required
|
string
132 characters
|
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
Sets the new controller address.
|
newController
required
|
string
42 characters
The new controller address |
The Freight Trust signature of the nonce
|
signature
required
|
string
132 characters
|
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
Calls the pause method in the universal proxy, blocking any state changes while Freight Trust's Network Operations Group updates.
The Freight Trust signature of the nonce
|
signature
required
|
string
132 characters
|
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
|
owner
required
|
string
42 characters
The address of the owner |
|
index
required
|
integer
[ 0 .. 1.157920892373162e+77 ]
The index of the nft assigned to the owner |
{
-
"code": 0,
-
"type":
"string",
-
"message":
"string"
}
|
from
required
|
string
42 characters
The sender of the transfer |
|
to
required
|
string
42 characters
The recipient of the transfer |
|
tokenId
required
|
integer
[ 0 .. 1.157920892373162e+77 ]
The id of the token to be transferred |
| extraData |
string
Optional data to be sent with the transaction |
The Freight Trust signature of the nonce
|
signature
required
|
string
132 characters
|
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
{
-
"code": 0,
-
"type":
"string",
-
"message":
"string"
}
Allows Freight Trust to tranfer tokens unsafely -- THE
CALLER IS RESPONSIBLE TO CONFIRM THAT _to IS
CAPABLE OF RECEIVING NFTS OR ELSE THEY MAY BE PERMANENTLY
LOST
|
from
required
|
string
42 characters
The sender of the transfer |
|
to
required
|
string
42 characters
The recipient of the transfer |
|
tokenId
required
|
integer
[ 0 .. 1.157920892373162e+77 ]
The id of the token to be transferred |
The Freight Trust signature of the nonce
|
signature
required
|
string
132 characters
|
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
{
-
"code": 0,
-
"type":
"string",
-
"message":
"string"
}
|
approved
required
|
string
42 characters
The address being approved |
|
tokenId
required
|
integer
[ 0 .. 1.157920892373162e+77 ]
The id of the token to be approved |
The Freight Trust signature of the nonce
|
signature
required
|
string
132 characters
|
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
{
-
"code": 0,
-
"type":
"string",
-
"message":
"string"
}
Enable or disable approval for a third party
(operator) to manage all of Freight
Trust's assets
|
operator
required
|
string
42 characters
Address to add to the set of authorized operators |
|
approved
required
|
boolean
True if the operator is approved, false to revoke approval |
The Freight Trust signature of the nonce
|
signature
required
|
string
132 characters
|
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
{
-
"code": 0,
-
"type":
"string",
-
"message":
"string"
}
The approved address for this NFT, or the zero address if there is none
|
tokenId
required
|
integer
[ 0 .. 1.157920892373162e+77 ]
The NFT to find the approved address for |
{
-
"code": 0,
-
"type":
"string",
-
"message":
"string"
}
True if operator is an approved operator for
owner, false otherwise
|
owner
required
|
string
42 characters
The address that owns the NFTs |
|
operator
required
|
string
42 characters
The address that acts on behalf of the owner |
{
-
"code": 0,
-
"type":
"string",
-
"message":
"string"
}
Allows Freight Trust to sign and transfer a ERC721 token on the behalf of its holder
|
from
required
|
string
42 characters
The sender of the transfer |
|
to
required
|
string
42 characters
The recipient of the transfer |
|
tokenId
required
|
integer
[ 0 .. 1.157920892373162e+77 ]
The id of the token to be transferred |
| data |
string
Optional data to be sent with the transaction |
The Freight Trust authorization signature followed by the signature of the sender of the transfer.
|
object
(auth)
|
|
|
object
(auth)
|
{
-
"freightTrustAuth":
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
},
-
"senderAuth":
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
}
{
-
"code": 0,
-
"type":
"string",
-
"message":
"string"
}
Allows Freight Trust to create a record with the signature of the owner and of the participant.
|
recordID
required
|
string
66 characters
The identifying hash of the record |
|
owner
required
|
string
42 characters
The owner of the record |
|
participant
required
|
string
42 characters
The address of the participant in the record |
The Freight Trust nonce signature, followed by the owner's signature and the participant's signature
|
object
(auth)
|
|
|
object
(auth)
|
|
|
object
(auth)
|
{
-
"freightTrustAuth":
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
},
-
"ownerAuth":
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
},
-
"partAuth":
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
}
{
-
"code": 0,
-
"type":
"string",
-
"message":
"string"
}
Allows Freight Trust to version one of the records they own.
|
current
required
|
string
66 characters
The identifying hash of the record |
|
new
required
|
string
66 characters
The new identifying hash of the record |
The Freight Trust nonce signature to verify this action
|
signature
required
|
string
132 characters
|
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
Allows Freight Trust to version a record for the owner using the owner's signature.
|
current
required
|
string
66 characters
The identifying hash of the record |
|
new
required
|
string
66 characters
The new identifying hash of the record |
| owner |
string
42 characters
The owner of the record which will be updated |
The Freight Trust nonce signature followed by the owner's signature
|
object
(auth)
|
|
|
object
(auth)
|
{
-
"freightTrustAuth":
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
},
-
"ownerAuth":
{
-
"signature":
"stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}
}