@aptos-labs/ts-sdk 0.0.7 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -10
- package/dist/browser/index.d.ts +818 -446
- package/dist/browser/index.global.js +30 -30
- package/dist/browser/index.global.js.map +1 -1
- package/dist/common/index.d.ts +818 -446
- package/dist/common/index.js +29 -29
- package/dist/common/index.js.map +1 -1
- package/dist/esm/api/account.d.mts +72 -47
- package/dist/esm/api/account.mjs +1 -1
- package/dist/esm/api/ans.d.mts +19 -17
- package/dist/esm/api/ans.mjs +1 -1
- package/dist/esm/api/aptos.d.mts +1 -0
- package/dist/esm/api/aptos.mjs +1 -1
- package/dist/esm/api/aptosConfig.d.mts +2 -2
- package/dist/esm/api/aptosConfig.mjs +1 -1
- package/dist/esm/api/coin.d.mts +4 -3
- package/dist/esm/api/coin.mjs +1 -1
- package/dist/esm/api/digitalAsset.d.mts +42 -19
- package/dist/esm/api/digitalAsset.mjs +1 -1
- package/dist/esm/api/event.d.mts +12 -14
- package/dist/esm/api/event.mjs +1 -1
- package/dist/esm/api/faucet.d.mts +4 -4
- package/dist/esm/api/faucet.mjs +1 -1
- package/dist/esm/api/fungibleAsset.d.mts +71 -30
- package/dist/esm/api/fungibleAsset.mjs +1 -1
- package/dist/esm/api/general.d.mts +12 -5
- package/dist/esm/api/general.mjs +1 -1
- package/dist/esm/api/index.d.mts +1 -0
- package/dist/esm/api/index.mjs +1 -1
- package/dist/esm/api/staking.d.mts +13 -9
- package/dist/esm/api/staking.mjs +1 -1
- package/dist/esm/api/transaction.d.mts +36 -2
- package/dist/esm/api/transaction.mjs +1 -1
- package/dist/esm/api/transactionSubmission/build.d.mts +1 -0
- package/dist/esm/api/transactionSubmission/build.mjs +1 -1
- package/dist/esm/api/transactionSubmission/sign.d.mts +1 -0
- package/dist/esm/api/transactionSubmission/sign.mjs +1 -1
- package/dist/esm/api/transactionSubmission/simulate.d.mts +1 -0
- package/dist/esm/api/transactionSubmission/simulate.mjs +1 -1
- package/dist/esm/api/transactionSubmission/submit.d.mts +1 -0
- package/dist/esm/api/transactionSubmission/submit.mjs +1 -1
- package/dist/esm/api/transactionSubmission.d.mts +23 -1
- package/dist/esm/api/transactionSubmission.mjs +1 -1
- package/dist/esm/api/utils.d.mts +21 -0
- package/dist/esm/api/utils.mjs +2 -0
- package/dist/esm/bcs/deserializer.d.mts +4 -4
- package/dist/esm/bcs/deserializer.mjs +1 -1
- package/dist/esm/bcs/index.mjs +1 -1
- package/dist/esm/bcs/serializable/entryFunctionBytes.mjs +1 -1
- package/dist/esm/bcs/serializable/fixedBytes.mjs +1 -1
- package/dist/esm/bcs/serializable/movePrimitives.mjs +1 -1
- package/dist/esm/bcs/serializable/moveStructs.mjs +1 -1
- package/dist/esm/bcs/serializer.d.mts +4 -4
- package/dist/esm/bcs/serializer.mjs +1 -1
- package/dist/esm/chunk-26GRNGPL.mjs +2 -0
- package/dist/esm/chunk-26GRNGPL.mjs.map +1 -0
- package/dist/esm/{chunk-72F5YXGC.mjs → chunk-2AMFCGJ3.mjs} +2 -2
- package/dist/esm/chunk-2AMFCGJ3.mjs.map +1 -0
- package/dist/esm/{chunk-ZUHN56GM.mjs → chunk-2X3FRUKX.mjs} +2 -2
- package/dist/esm/chunk-2X3FRUKX.mjs.map +1 -0
- package/dist/esm/chunk-32A35CPU.mjs +2 -0
- package/dist/esm/chunk-32A35CPU.mjs.map +1 -0
- package/dist/esm/{chunk-JZNLZMUC.mjs → chunk-3QS3MFWJ.mjs} +2 -2
- package/dist/esm/{chunk-ARVSIDVB.mjs → chunk-3RMXGSHK.mjs} +2 -2
- package/dist/esm/chunk-3RMXGSHK.mjs.map +1 -0
- package/dist/esm/chunk-4FDIPWVB.mjs +2 -0
- package/dist/esm/chunk-4FDIPWVB.mjs.map +1 -0
- package/dist/esm/{chunk-U25N2VWA.mjs → chunk-4K252UDE.mjs} +2 -2
- package/dist/esm/{chunk-3VZ3OZKC.mjs → chunk-4XQ5IV6C.mjs} +2 -2
- package/dist/esm/chunk-5HZKDT5C.mjs +2 -0
- package/dist/esm/chunk-5HZKDT5C.mjs.map +1 -0
- package/dist/esm/chunk-5IVRKK5V.mjs +2 -0
- package/dist/esm/chunk-5IVRKK5V.mjs.map +1 -0
- package/dist/esm/chunk-5SRMD5C6.mjs +2 -0
- package/dist/esm/chunk-5SRMD5C6.mjs.map +1 -0
- package/dist/esm/chunk-5X46HDCI.mjs +2 -0
- package/dist/esm/chunk-5X46HDCI.mjs.map +1 -0
- package/dist/esm/{chunk-HVADSXTB.mjs → chunk-6DYNAFAP.mjs} +2 -2
- package/dist/esm/chunk-6F4ACCCZ.mjs +2 -0
- package/dist/esm/chunk-6F4ACCCZ.mjs.map +1 -0
- package/dist/esm/{chunk-4ADA5BE7.mjs → chunk-7B3VSBCX.mjs} +2 -2
- package/dist/esm/chunk-7IY2Y73Q.mjs +2 -0
- package/dist/esm/chunk-7IY2Y73Q.mjs.map +1 -0
- package/dist/esm/chunk-7QJYTQSU.mjs +2 -0
- package/dist/esm/chunk-7QJYTQSU.mjs.map +1 -0
- package/dist/esm/chunk-ALFESCPU.mjs +2 -0
- package/dist/esm/chunk-ALFESCPU.mjs.map +1 -0
- package/dist/esm/chunk-BA4TDBYB.mjs +2 -0
- package/dist/esm/chunk-BA4TDBYB.mjs.map +1 -0
- package/dist/esm/chunk-BDTDWLGO.mjs +2 -0
- package/dist/esm/chunk-BDTDWLGO.mjs.map +1 -0
- package/dist/esm/{chunk-UDBH4CER.mjs → chunk-BQSE5HHW.mjs} +7 -7
- package/dist/esm/chunk-BQSE5HHW.mjs.map +1 -0
- package/dist/esm/chunk-C3Y52GHM.mjs +2 -0
- package/dist/esm/chunk-C3Y52GHM.mjs.map +1 -0
- package/dist/esm/chunk-CBAVJ5EN.mjs +2 -0
- package/dist/esm/chunk-CBAVJ5EN.mjs.map +1 -0
- package/dist/esm/chunk-DBJTMCAG.mjs +2 -0
- package/dist/esm/chunk-DBJTMCAG.mjs.map +1 -0
- package/dist/esm/chunk-DYJVDOBH.mjs +2 -0
- package/dist/esm/chunk-DYJVDOBH.mjs.map +1 -0
- package/dist/esm/chunk-EHJEK7FU.mjs +2 -0
- package/dist/esm/chunk-ELWWME6B.mjs +2 -0
- package/dist/esm/chunk-ELWWME6B.mjs.map +1 -0
- package/dist/esm/chunk-EOC4UI5B.mjs +2 -0
- package/dist/esm/{chunk-KC64ESLO.mjs.map → chunk-EOC4UI5B.mjs.map} +1 -1
- package/dist/esm/{chunk-BPYLPPEQ.mjs → chunk-F2GFSFPW.mjs} +2 -2
- package/dist/esm/{chunk-U6SZNNVL.mjs → chunk-F52GIFKT.mjs} +2 -2
- package/dist/esm/{chunk-U6SZNNVL.mjs.map → chunk-F52GIFKT.mjs.map} +1 -1
- package/dist/esm/{chunk-KQXRH5FK.mjs → chunk-FGTQT7Q5.mjs} +2 -2
- package/dist/esm/chunk-GMOHGD73.mjs +2 -0
- package/dist/esm/chunk-GMOHGD73.mjs.map +1 -0
- package/dist/esm/{chunk-HO7K2UAK.mjs → chunk-GQI3HWOB.mjs} +2 -2
- package/dist/esm/{chunk-UAAI3NCA.mjs → chunk-HQ4DGB7L.mjs} +2 -2
- package/dist/esm/chunk-IHYTP2EW.mjs +1 -0
- package/dist/esm/chunk-IHYTP2EW.mjs.map +1 -0
- package/dist/esm/{chunk-HA6JD5R6.mjs → chunk-IU5JZNH4.mjs} +2 -2
- package/dist/esm/{chunk-HA6JD5R6.mjs.map → chunk-IU5JZNH4.mjs.map} +1 -1
- package/dist/esm/{chunk-TPWSHFFI.mjs → chunk-KR5JAN32.mjs} +2 -2
- package/dist/esm/{chunk-QWVR4RCV.mjs → chunk-KVJ2KGMW.mjs} +2 -2
- package/dist/esm/chunk-LBNMY7EM.mjs +2 -0
- package/dist/esm/chunk-LBNMY7EM.mjs.map +1 -0
- package/dist/esm/chunk-MNFGMNYS.mjs +2 -0
- package/dist/esm/chunk-MNFGMNYS.mjs.map +1 -0
- package/dist/esm/{chunk-IBH7IOIM.mjs → chunk-N25GOEVL.mjs} +2 -2
- package/dist/esm/chunk-NBSXZKMQ.mjs +2 -0
- package/dist/esm/chunk-NBSXZKMQ.mjs.map +1 -0
- package/dist/esm/chunk-NFGAZSSK.mjs +2 -0
- package/dist/esm/{chunk-ND3ZQKTT.mjs.map → chunk-NFGAZSSK.mjs.map} +1 -1
- package/dist/esm/chunk-NL72WE3E.mjs +2 -0
- package/dist/esm/{chunk-TIH6ARYP.mjs.map → chunk-NL72WE3E.mjs.map} +1 -1
- package/dist/esm/{chunk-EWTHPMEE.mjs → chunk-NLONZHYT.mjs} +2 -2
- package/dist/esm/{chunk-44MGBJ73.mjs → chunk-NMFS5KAE.mjs} +2 -2
- package/dist/esm/{chunk-4KTQIWUP.mjs → chunk-NZ36UN4C.mjs} +2 -2
- package/dist/esm/{chunk-YYRDFZE6.mjs → chunk-OWP2MKTX.mjs} +2 -2
- package/dist/esm/{chunk-YYRDFZE6.mjs.map → chunk-OWP2MKTX.mjs.map} +1 -1
- package/dist/esm/{chunk-WL4OXZLN.mjs → chunk-OXO3Z2MF.mjs} +2 -2
- package/dist/esm/{chunk-S36IYY6K.mjs → chunk-PANYJULW.mjs} +2 -2
- package/dist/esm/{chunk-DRPMIJH7.mjs → chunk-PEBXSNMJ.mjs} +2 -2
- package/dist/esm/chunk-PLY7MQKE.mjs +2 -0
- package/dist/esm/chunk-PLY7MQKE.mjs.map +1 -0
- package/dist/esm/chunk-PRKZ2KJ4.mjs +2 -0
- package/dist/esm/{chunk-R3KWVOFG.mjs.map → chunk-PRKZ2KJ4.mjs.map} +1 -1
- package/dist/esm/{chunk-GAI75GOG.mjs → chunk-PZ5JKQSP.mjs} +2 -2
- package/dist/esm/chunk-Q3R3KKKP.mjs +2 -0
- package/dist/esm/chunk-Q3R3KKKP.mjs.map +1 -0
- package/dist/esm/chunk-RCYWJZR4.mjs +2 -0
- package/dist/esm/chunk-RCYWJZR4.mjs.map +1 -0
- package/dist/esm/chunk-TNUGIBLO.mjs +2 -0
- package/dist/esm/chunk-TNUGIBLO.mjs.map +1 -0
- package/dist/esm/{chunk-3732I6BR.mjs → chunk-TTICPGX6.mjs} +2 -2
- package/dist/esm/chunk-U6Z4FNB7.mjs +2 -0
- package/dist/esm/chunk-U6Z4FNB7.mjs.map +1 -0
- package/dist/esm/{chunk-GTC7WHMV.mjs → chunk-UDMADMVO.mjs} +1 -1
- package/dist/esm/{chunk-GTC7WHMV.mjs.map → chunk-UDMADMVO.mjs.map} +1 -1
- package/dist/esm/chunk-UES76WF2.mjs +2 -0
- package/dist/esm/chunk-UES76WF2.mjs.map +1 -0
- package/dist/esm/chunk-UIVJXLRM.mjs +1 -0
- package/dist/esm/chunk-UIVJXLRM.mjs.map +1 -0
- package/dist/esm/chunk-UR5E2UDO.mjs +2 -0
- package/dist/esm/chunk-UR5E2UDO.mjs.map +1 -0
- package/dist/esm/{chunk-X32O46IB.mjs → chunk-VMCFN5CT.mjs} +2 -2
- package/dist/esm/{chunk-5LO7FR2P.mjs → chunk-W44E6YAW.mjs} +2 -2
- package/dist/esm/chunk-W4JEP5GW.mjs +2 -0
- package/dist/esm/{chunk-FYIFBLHU.mjs.map → chunk-W4JEP5GW.mjs.map} +1 -1
- package/dist/esm/chunk-WXISFVRU.mjs +2 -0
- package/dist/esm/chunk-WXISFVRU.mjs.map +1 -0
- package/dist/esm/chunk-X7QBDRQR.mjs +2 -0
- package/dist/esm/chunk-X7QBDRQR.mjs.map +1 -0
- package/dist/esm/chunk-XKINEFAA.mjs +2 -0
- package/dist/esm/chunk-XKINEFAA.mjs.map +1 -0
- package/dist/esm/chunk-Y5RQOXZH.mjs +2 -0
- package/dist/esm/chunk-Y5RQOXZH.mjs.map +1 -0
- package/dist/esm/chunk-ZKFDLJ2F.mjs +2 -0
- package/dist/esm/chunk-ZKFDLJ2F.mjs.map +1 -0
- package/dist/esm/client/core.mjs +1 -1
- package/dist/esm/client/get.d.mts +1 -1
- package/dist/esm/client/get.mjs +1 -1
- package/dist/esm/client/index.mjs +1 -1
- package/dist/esm/client/post.mjs +1 -1
- package/dist/esm/core/account.mjs +1 -1
- package/dist/esm/core/accountAddress.d.mts +9 -9
- package/dist/esm/core/accountAddress.mjs +1 -1
- package/dist/esm/core/authenticationKey.mjs +1 -1
- package/dist/esm/core/crypto/anyPublicKey.d.mts +5 -0
- package/dist/esm/core/crypto/anyPublicKey.mjs +1 -1
- package/dist/esm/core/crypto/anySignature.mjs +1 -1
- package/dist/esm/core/crypto/asymmetricCrypto.mjs +1 -1
- package/dist/esm/core/crypto/ed25519.d.mts +3 -0
- package/dist/esm/core/crypto/ed25519.mjs +1 -1
- package/dist/esm/core/crypto/index.d.mts +2 -2
- package/dist/esm/core/crypto/index.mjs +1 -1
- package/dist/esm/core/crypto/multiEd25519.mjs +1 -1
- package/dist/esm/core/crypto/multiKey.d.mts +2 -0
- package/dist/esm/core/crypto/multiKey.mjs +1 -1
- package/dist/esm/core/crypto/secp256k1.d.mts +3 -0
- package/dist/esm/core/crypto/secp256k1.mjs +1 -1
- package/dist/esm/core/hex.mjs +1 -1
- package/dist/esm/core/index.d.mts +2 -2
- package/dist/esm/core/index.mjs +1 -1
- package/dist/esm/index.d.mts +11 -8
- package/dist/esm/index.mjs +1 -1
- package/dist/esm/internal/account.d.mts +20 -33
- package/dist/esm/internal/account.mjs +1 -1
- package/dist/esm/internal/ans.d.mts +7 -10
- package/dist/esm/internal/ans.mjs +1 -1
- package/dist/esm/internal/coin.d.mts +4 -3
- package/dist/esm/internal/coin.mjs +1 -1
- package/dist/esm/internal/digitalAsset.d.mts +19 -20
- package/dist/esm/internal/digitalAsset.mjs +1 -1
- package/dist/esm/internal/event.d.mts +5 -12
- package/dist/esm/internal/event.mjs +1 -1
- package/dist/esm/internal/faucet.d.mts +5 -5
- package/dist/esm/internal/faucet.mjs +1 -1
- package/dist/esm/internal/fungibleAsset.d.mts +39 -14
- package/dist/esm/internal/fungibleAsset.mjs +1 -1
- package/dist/esm/internal/general.d.mts +9 -5
- package/dist/esm/internal/general.mjs +1 -1
- package/dist/esm/internal/staking.d.mts +5 -7
- package/dist/esm/internal/staking.mjs +1 -1
- package/dist/esm/internal/transaction.d.mts +12 -4
- package/dist/esm/internal/transaction.mjs +1 -1
- package/dist/esm/internal/transactionSubmission.d.mts +24 -5
- package/dist/esm/internal/transactionSubmission.mjs +1 -1
- package/dist/esm/transactions/authenticator/account.d.mts +5 -0
- package/dist/esm/transactions/authenticator/account.mjs +1 -1
- package/dist/esm/transactions/authenticator/index.d.mts +1 -0
- package/dist/esm/transactions/authenticator/index.mjs +1 -1
- package/dist/esm/transactions/authenticator/transaction.d.mts +1 -0
- package/dist/esm/transactions/authenticator/transaction.mjs +1 -1
- package/dist/esm/transactions/index.d.mts +4 -3
- package/dist/esm/transactions/index.mjs +1 -1
- package/dist/esm/transactions/instances/chainId.mjs +1 -1
- package/dist/esm/transactions/instances/identifier.mjs +1 -1
- package/dist/esm/transactions/instances/index.d.mts +1 -0
- package/dist/esm/transactions/instances/index.mjs +1 -1
- package/dist/esm/transactions/instances/moduleId.mjs +1 -1
- package/dist/esm/transactions/instances/rawTransaction.mjs +1 -1
- package/dist/esm/transactions/instances/rotationProofChallenge.mjs +1 -1
- package/dist/esm/transactions/instances/signedTransaction.d.mts +1 -0
- package/dist/esm/transactions/instances/signedTransaction.mjs +1 -1
- package/dist/esm/transactions/instances/transactionPayload.mjs +1 -1
- package/dist/esm/transactions/management/accountSequenceNumber.d.mts +89 -0
- package/dist/esm/transactions/management/accountSequenceNumber.mjs +2 -0
- package/dist/esm/transactions/management/accountSequenceNumber.mjs.map +1 -0
- package/dist/esm/transactions/management/asyncQueue.d.mts +58 -0
- package/dist/esm/transactions/management/asyncQueue.mjs +2 -0
- package/dist/esm/transactions/management/asyncQueue.mjs.map +1 -0
- package/dist/esm/transactions/management/index.d.mts +36 -0
- package/dist/esm/transactions/management/index.mjs +2 -0
- package/dist/esm/transactions/management/index.mjs.map +1 -0
- package/dist/esm/transactions/management/transactionWorker.d.mts +135 -0
- package/dist/esm/transactions/management/transactionWorker.mjs +2 -0
- package/dist/esm/transactions/management/transactionWorker.mjs.map +1 -0
- package/dist/esm/transactions/transactionBuilder/helpers.d.mts +3 -1
- package/dist/esm/transactions/transactionBuilder/helpers.mjs +1 -1
- package/dist/esm/transactions/transactionBuilder/index.d.mts +4 -3
- package/dist/esm/transactions/transactionBuilder/index.mjs +1 -1
- package/dist/esm/transactions/transactionBuilder/remoteAbi.d.mts +3 -1
- package/dist/esm/transactions/transactionBuilder/remoteAbi.mjs +1 -1
- package/dist/esm/transactions/transactionBuilder/transactionBuilder.d.mts +3 -2
- package/dist/esm/transactions/transactionBuilder/transactionBuilder.mjs +1 -1
- package/dist/esm/transactions/typeTag/index.mjs +1 -1
- package/dist/esm/transactions/typeTag/parser.mjs +1 -1
- package/dist/esm/transactions/types.d.mts +3 -2
- package/dist/esm/types/generated/operations.d.mts +3 -3
- package/dist/esm/types/generated/queries.d.mts +3 -3
- package/dist/esm/types/generated/queries.mjs +1 -1
- package/dist/esm/types/index.d.mts +27 -9
- package/dist/esm/types/index.mjs +1 -1
- package/dist/esm/utils/const.d.mts +18 -1
- package/dist/esm/utils/const.mjs +1 -1
- package/dist/esm/utils/index.d.mts +1 -1
- package/dist/esm/utils/index.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/src/api/account.ts +150 -53
- package/src/api/ans.ts +19 -22
- package/src/api/aptosConfig.ts +2 -2
- package/src/api/coin.ts +2 -6
- package/src/api/digitalAsset.ts +98 -23
- package/src/api/event.ts +28 -17
- package/src/api/faucet.ts +12 -9
- package/src/api/fungibleAsset.ts +76 -35
- package/src/api/general.ts +19 -3
- package/src/api/staking.ts +30 -11
- package/src/api/transaction.ts +16 -1
- package/src/api/transactionSubmission.ts +43 -1
- package/src/api/utils.ts +37 -0
- package/src/bcs/deserializer.ts +4 -4
- package/src/bcs/serializer.ts +4 -4
- package/src/client/core.ts +6 -4
- package/src/client/get.ts +7 -6
- package/src/core/accountAddress.ts +20 -22
- package/src/core/crypto/anyPublicKey.ts +12 -0
- package/src/core/crypto/ed25519.ts +13 -0
- package/src/core/crypto/index.ts +2 -0
- package/src/core/crypto/secp256k1.ts +12 -0
- package/src/core/hex.ts +5 -7
- package/src/index.ts +1 -0
- package/src/internal/account.ts +56 -50
- package/src/internal/ans.ts +52 -39
- package/src/internal/coin.ts +4 -6
- package/src/internal/digitalAsset.ts +36 -22
- package/src/internal/event.ts +7 -14
- package/src/internal/faucet.ts +10 -6
- package/src/internal/fungibleAsset.ts +36 -18
- package/src/internal/general.ts +30 -3
- package/src/internal/queries/getNumberOfDelegatorsQuery.graphql +5 -5
- package/src/internal/queries/getProcessorStatus.graphql +2 -2
- package/src/internal/staking.ts +12 -14
- package/src/internal/transaction.ts +23 -26
- package/src/internal/transactionSubmission.ts +35 -5
- package/src/transactions/authenticator/account.ts +16 -0
- package/src/transactions/instances/moduleId.ts +1 -1
- package/src/transactions/management/accountSequenceNumber.ts +186 -0
- package/src/transactions/management/asyncQueue.ts +107 -0
- package/src/transactions/management/index.ts +2 -0
- package/src/transactions/management/transactionWorker.ts +275 -0
- package/src/transactions/transactionBuilder/helpers.ts +28 -1
- package/src/transactions/transactionBuilder/remoteAbi.ts +47 -32
- package/src/transactions/transactionBuilder/transactionBuilder.ts +28 -26
- package/src/transactions/typeTag/index.ts +1 -0
- package/src/transactions/typeTag/parser.ts +1 -1
- package/src/transactions/types.ts +2 -2
- package/src/types/generated/operations.ts +4 -2
- package/src/types/generated/queries.ts +4 -4
- package/src/types/index.ts +67 -11
- package/src/utils/const.ts +18 -0
- package/src/version.ts +1 -1
- package/dist/esm/chunk-2OZRBXLM.mjs +0 -2
- package/dist/esm/chunk-2OZRBXLM.mjs.map +0 -1
- package/dist/esm/chunk-33T7WTB6.mjs +0 -2
- package/dist/esm/chunk-33T7WTB6.mjs.map +0 -1
- package/dist/esm/chunk-62SCW5NH.mjs +0 -2
- package/dist/esm/chunk-62SCW5NH.mjs.map +0 -1
- package/dist/esm/chunk-67OGU66P.mjs +0 -2
- package/dist/esm/chunk-67OGU66P.mjs.map +0 -1
- package/dist/esm/chunk-72F5YXGC.mjs.map +0 -1
- package/dist/esm/chunk-ARVSIDVB.mjs.map +0 -1
- package/dist/esm/chunk-BFQRMCY2.mjs +0 -2
- package/dist/esm/chunk-BFQRMCY2.mjs.map +0 -1
- package/dist/esm/chunk-BM4HBROC.mjs +0 -2
- package/dist/esm/chunk-BM4HBROC.mjs.map +0 -1
- package/dist/esm/chunk-BV4OOU5Y.mjs +0 -2
- package/dist/esm/chunk-BV4OOU5Y.mjs.map +0 -1
- package/dist/esm/chunk-EFIYW4WK.mjs +0 -2
- package/dist/esm/chunk-FYIFBLHU.mjs +0 -2
- package/dist/esm/chunk-GU4OUKAF.mjs +0 -2
- package/dist/esm/chunk-GU4OUKAF.mjs.map +0 -1
- package/dist/esm/chunk-J5BH7V37.mjs +0 -2
- package/dist/esm/chunk-J5BH7V37.mjs.map +0 -1
- package/dist/esm/chunk-KC64ESLO.mjs +0 -2
- package/dist/esm/chunk-L7AA75WZ.mjs +0 -2
- package/dist/esm/chunk-L7AA75WZ.mjs.map +0 -1
- package/dist/esm/chunk-LACQ537H.mjs +0 -2
- package/dist/esm/chunk-LACQ537H.mjs.map +0 -1
- package/dist/esm/chunk-LDAD54H5.mjs +0 -2
- package/dist/esm/chunk-LDAD54H5.mjs.map +0 -1
- package/dist/esm/chunk-LXW3A3MJ.mjs +0 -2
- package/dist/esm/chunk-LXW3A3MJ.mjs.map +0 -1
- package/dist/esm/chunk-M2V2POWK.mjs +0 -2
- package/dist/esm/chunk-M2V2POWK.mjs.map +0 -1
- package/dist/esm/chunk-ND3ZQKTT.mjs +0 -2
- package/dist/esm/chunk-NZIJV4O2.mjs +0 -2
- package/dist/esm/chunk-NZIJV4O2.mjs.map +0 -1
- package/dist/esm/chunk-O2B54NZT.mjs +0 -2
- package/dist/esm/chunk-O2B54NZT.mjs.map +0 -1
- package/dist/esm/chunk-OCW2L33Q.mjs +0 -2
- package/dist/esm/chunk-OCW2L33Q.mjs.map +0 -1
- package/dist/esm/chunk-OCYS4V2V.mjs +0 -2
- package/dist/esm/chunk-OCYS4V2V.mjs.map +0 -1
- package/dist/esm/chunk-OSTH5JRX.mjs +0 -2
- package/dist/esm/chunk-OSTH5JRX.mjs.map +0 -1
- package/dist/esm/chunk-OVHY6ZUJ.mjs +0 -2
- package/dist/esm/chunk-OVHY6ZUJ.mjs.map +0 -1
- package/dist/esm/chunk-PZCMSHY6.mjs +0 -2
- package/dist/esm/chunk-PZCMSHY6.mjs.map +0 -1
- package/dist/esm/chunk-R3KWVOFG.mjs +0 -2
- package/dist/esm/chunk-RHS5ROLP.mjs +0 -2
- package/dist/esm/chunk-RHS5ROLP.mjs.map +0 -1
- package/dist/esm/chunk-RKKU2SY5.mjs +0 -2
- package/dist/esm/chunk-RKKU2SY5.mjs.map +0 -1
- package/dist/esm/chunk-RYETO74W.mjs +0 -2
- package/dist/esm/chunk-RYETO74W.mjs.map +0 -1
- package/dist/esm/chunk-TCTZCPQ6.mjs +0 -1
- package/dist/esm/chunk-TGKB6ALT.mjs +0 -2
- package/dist/esm/chunk-TGKB6ALT.mjs.map +0 -1
- package/dist/esm/chunk-TIH6ARYP.mjs +0 -2
- package/dist/esm/chunk-UDBH4CER.mjs.map +0 -1
- package/dist/esm/chunk-VWVEDCBM.mjs +0 -2
- package/dist/esm/chunk-VWVEDCBM.mjs.map +0 -1
- package/dist/esm/chunk-WEJAI26R.mjs +0 -2
- package/dist/esm/chunk-WEJAI26R.mjs.map +0 -1
- package/dist/esm/chunk-Y2HRRUZ6.mjs +0 -2
- package/dist/esm/chunk-Y2HRRUZ6.mjs.map +0 -1
- package/dist/esm/chunk-Y7VR7X5W.mjs +0 -2
- package/dist/esm/chunk-Y7VR7X5W.mjs.map +0 -1
- package/dist/esm/chunk-ZLW65YCO.mjs +0 -2
- package/dist/esm/chunk-ZLW65YCO.mjs.map +0 -1
- package/dist/esm/chunk-ZUHN56GM.mjs.map +0 -1
- /package/dist/esm/{chunk-TCTZCPQ6.mjs.map → api/utils.mjs.map} +0 -0
- /package/dist/esm/{chunk-JZNLZMUC.mjs.map → chunk-3QS3MFWJ.mjs.map} +0 -0
- /package/dist/esm/{chunk-U25N2VWA.mjs.map → chunk-4K252UDE.mjs.map} +0 -0
- /package/dist/esm/{chunk-3VZ3OZKC.mjs.map → chunk-4XQ5IV6C.mjs.map} +0 -0
- /package/dist/esm/{chunk-HVADSXTB.mjs.map → chunk-6DYNAFAP.mjs.map} +0 -0
- /package/dist/esm/{chunk-4ADA5BE7.mjs.map → chunk-7B3VSBCX.mjs.map} +0 -0
- /package/dist/esm/{chunk-EFIYW4WK.mjs.map → chunk-EHJEK7FU.mjs.map} +0 -0
- /package/dist/esm/{chunk-BPYLPPEQ.mjs.map → chunk-F2GFSFPW.mjs.map} +0 -0
- /package/dist/esm/{chunk-KQXRH5FK.mjs.map → chunk-FGTQT7Q5.mjs.map} +0 -0
- /package/dist/esm/{chunk-HO7K2UAK.mjs.map → chunk-GQI3HWOB.mjs.map} +0 -0
- /package/dist/esm/{chunk-UAAI3NCA.mjs.map → chunk-HQ4DGB7L.mjs.map} +0 -0
- /package/dist/esm/{chunk-TPWSHFFI.mjs.map → chunk-KR5JAN32.mjs.map} +0 -0
- /package/dist/esm/{chunk-QWVR4RCV.mjs.map → chunk-KVJ2KGMW.mjs.map} +0 -0
- /package/dist/esm/{chunk-IBH7IOIM.mjs.map → chunk-N25GOEVL.mjs.map} +0 -0
- /package/dist/esm/{chunk-EWTHPMEE.mjs.map → chunk-NLONZHYT.mjs.map} +0 -0
- /package/dist/esm/{chunk-44MGBJ73.mjs.map → chunk-NMFS5KAE.mjs.map} +0 -0
- /package/dist/esm/{chunk-4KTQIWUP.mjs.map → chunk-NZ36UN4C.mjs.map} +0 -0
- /package/dist/esm/{chunk-WL4OXZLN.mjs.map → chunk-OXO3Z2MF.mjs.map} +0 -0
- /package/dist/esm/{chunk-S36IYY6K.mjs.map → chunk-PANYJULW.mjs.map} +0 -0
- /package/dist/esm/{chunk-DRPMIJH7.mjs.map → chunk-PEBXSNMJ.mjs.map} +0 -0
- /package/dist/esm/{chunk-GAI75GOG.mjs.map → chunk-PZ5JKQSP.mjs.map} +0 -0
- /package/dist/esm/{chunk-3732I6BR.mjs.map → chunk-TTICPGX6.mjs.map} +0 -0
- /package/dist/esm/{chunk-X32O46IB.mjs.map → chunk-VMCFN5CT.mjs.map} +0 -0
- /package/dist/esm/{chunk-5LO7FR2P.mjs.map → chunk-W44E6YAW.mjs.map} +0 -0
package/dist/browser/index.d.ts
CHANGED
|
@@ -1,3 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This error is used to explain why parsing failed.
|
|
3
|
+
*/
|
|
4
|
+
declare class ParsingError<T> extends Error {
|
|
5
|
+
/**
|
|
6
|
+
* This provides a programmatic way to access why parsing failed. Downstream devs
|
|
7
|
+
* might want to use this to build their own error messages if the default error
|
|
8
|
+
* messages are not suitable for their use case. This should be an enum.
|
|
9
|
+
*/
|
|
10
|
+
invalidReason: T;
|
|
11
|
+
constructor(message: string, invalidReason: T);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Whereas ParsingError is thrown when parsing fails, e.g. in a fromString function,
|
|
15
|
+
* this type is returned from "defensive" functions like isValid.
|
|
16
|
+
*/
|
|
17
|
+
type ParsingResult<T> = {
|
|
18
|
+
/**
|
|
19
|
+
* True if valid, false otherwise.
|
|
20
|
+
*/
|
|
21
|
+
valid: boolean;
|
|
22
|
+
/**
|
|
23
|
+
* If valid is false, this will be a code explaining why parsing failed.
|
|
24
|
+
*/
|
|
25
|
+
invalidReason?: T;
|
|
26
|
+
/**
|
|
27
|
+
* If valid is false, this will be a string explaining why parsing failed.
|
|
28
|
+
*/
|
|
29
|
+
invalidReasonMessage?: string;
|
|
30
|
+
};
|
|
31
|
+
|
|
1
32
|
declare const NetworkToIndexerAPI: Record<string, string>;
|
|
2
33
|
declare const NetworkToNodeAPI: Record<string, string>;
|
|
3
34
|
declare const NetworkToFaucetAPI: Record<string, string>;
|
|
@@ -835,6 +866,15 @@ interface PaginationArgs {
|
|
|
835
866
|
offset?: AnyNumber;
|
|
836
867
|
limit?: number;
|
|
837
868
|
}
|
|
869
|
+
interface TokenStandardArg {
|
|
870
|
+
tokenStandard?: TokenStandard;
|
|
871
|
+
}
|
|
872
|
+
interface OrderByArg<T extends {}> {
|
|
873
|
+
orderBy?: OrderBy<T>;
|
|
874
|
+
}
|
|
875
|
+
interface WhereArg<T extends {}> {
|
|
876
|
+
where?: T;
|
|
877
|
+
}
|
|
838
878
|
/**
|
|
839
879
|
* QUERY TYPES
|
|
840
880
|
*/
|
|
@@ -900,7 +940,7 @@ type AptosRequest = {
|
|
|
900
940
|
/**
|
|
901
941
|
* Specifies ledger version of transactions. By default latest version will be used
|
|
902
942
|
*/
|
|
903
|
-
type
|
|
943
|
+
type LedgerVersionArg = {
|
|
904
944
|
ledgerVersion?: AnyNumber;
|
|
905
945
|
};
|
|
906
946
|
/**
|
|
@@ -945,7 +985,13 @@ declare enum TransactionResponseType {
|
|
|
945
985
|
BlockMetadata = "block_metadata_transaction",
|
|
946
986
|
StateCheckpoint = "state_checkpoint_transaction"
|
|
947
987
|
}
|
|
948
|
-
type TransactionResponse = PendingTransactionResponse |
|
|
988
|
+
type TransactionResponse = PendingTransactionResponse | CommittedTransactionResponse;
|
|
989
|
+
type CommittedTransactionResponse = UserTransactionResponse | GenesisTransactionResponse | BlockMetadataTransactionResponse | StateCheckpointTransactionResponse;
|
|
990
|
+
declare function isPendingTransactionResponse(response: TransactionResponse): response is PendingTransactionResponse;
|
|
991
|
+
declare function isUserTransactionResponse(response: TransactionResponse): response is UserTransactionResponse;
|
|
992
|
+
declare function isGenesisTransactionResponse(response: TransactionResponse): response is GenesisTransactionResponse;
|
|
993
|
+
declare function isBlockMetadataTransactionResponse(response: TransactionResponse): response is BlockMetadataTransactionResponse;
|
|
994
|
+
declare function isStateCheckpointTransactionResponse(response: TransactionResponse): response is StateCheckpointTransactionResponse;
|
|
949
995
|
type PendingTransactionResponse = {
|
|
950
996
|
type: TransactionResponseType.Pending;
|
|
951
997
|
hash: string;
|
|
@@ -1202,6 +1248,11 @@ type MoveScriptBytecode = {
|
|
|
1202
1248
|
* These are the JSON representations of transaction signatures returned from the node API.
|
|
1203
1249
|
*/
|
|
1204
1250
|
type TransactionSignature = TransactionEd25519Signature | TransactionSecp256k1Signature | TransactionMultiEd25519Signature | TransactionMultiAgentSignature | TransactionFeePayerSignature;
|
|
1251
|
+
declare function isEd25519Signature(signature: TransactionSignature): signature is TransactionFeePayerSignature;
|
|
1252
|
+
declare function isSecp256k1Signature(signature: TransactionSignature): signature is TransactionFeePayerSignature;
|
|
1253
|
+
declare function isMultiAgentSignature(signature: TransactionSignature): signature is TransactionMultiAgentSignature;
|
|
1254
|
+
declare function isFeePayerSignature(signature: TransactionSignature): signature is TransactionFeePayerSignature;
|
|
1255
|
+
declare function isMultiEd25519Signature(signature: TransactionSignature): signature is TransactionMultiEd25519Signature;
|
|
1205
1256
|
type TransactionEd25519Signature = {
|
|
1206
1257
|
type: string;
|
|
1207
1258
|
public_key: string;
|
|
@@ -1257,10 +1308,7 @@ type TransactionFeePayerSignature = {
|
|
|
1257
1308
|
/**
|
|
1258
1309
|
* The union of all single account signatures.
|
|
1259
1310
|
*/
|
|
1260
|
-
type AccountSignature =
|
|
1261
|
-
type AccountEd25519Signature = TransactionEd25519Signature;
|
|
1262
|
-
type AccountSecp256k1Signature = TransactionSecp256k1Signature;
|
|
1263
|
-
type AccountMultiEd25519Signature = TransactionMultiEd25519Signature;
|
|
1311
|
+
type AccountSignature = TransactionEd25519Signature | TransactionSecp256k1Signature | TransactionMultiEd25519Signature;
|
|
1264
1312
|
type WriteSet = ScriptWriteSet | DirectWriteSet;
|
|
1265
1313
|
type ScriptWriteSet = {
|
|
1266
1314
|
type: string;
|
|
@@ -1564,7 +1612,7 @@ declare enum DeriveScheme {
|
|
|
1564
1612
|
type WaitForTransactionOptions = {
|
|
1565
1613
|
timeoutSecs?: number;
|
|
1566
1614
|
checkSuccess?: boolean;
|
|
1567
|
-
|
|
1615
|
+
waitForIndexer?: boolean;
|
|
1568
1616
|
};
|
|
1569
1617
|
/**
|
|
1570
1618
|
* Input type to generate an account using Single Signer
|
|
@@ -1584,121 +1632,6 @@ type GenerateAccountWithSingleSignerSecp256k1Key = {
|
|
|
1584
1632
|
};
|
|
1585
1633
|
type GenerateAccount = GenerateAccountWithEd25519 | GenerateAccountWithSingleSignerSecp256k1Key;
|
|
1586
1634
|
|
|
1587
|
-
/**
|
|
1588
|
-
* Type of API endpoint for request routing
|
|
1589
|
-
*/
|
|
1590
|
-
declare enum AptosApiType {
|
|
1591
|
-
FULLNODE = 0,
|
|
1592
|
-
INDEXER = 1,
|
|
1593
|
-
FAUCET = 2
|
|
1594
|
-
}
|
|
1595
|
-
declare const DEFAULT_NETWORK = Network.DEVNET;
|
|
1596
|
-
/**
|
|
1597
|
-
* The default max gas amount when none is given.
|
|
1598
|
-
*
|
|
1599
|
-
* This is the maximum number of gas units that will be used by a transaction before being rejected.
|
|
1600
|
-
*
|
|
1601
|
-
* Note that max gas amount varies based on the transaction. A larger transaction will go over this
|
|
1602
|
-
* default gas amount, and the value will need to be changed for the specific transaction.
|
|
1603
|
-
*/
|
|
1604
|
-
declare const DEFAULT_MAX_GAS_AMOUNT = 200000;
|
|
1605
|
-
/**
|
|
1606
|
-
* The default transaction expiration seconds from now.
|
|
1607
|
-
*
|
|
1608
|
-
* This time is how long until the blockchain nodes will reject the transaction.
|
|
1609
|
-
*
|
|
1610
|
-
* Note that the transaction expiration time varies based on network connection and network load. It may need to be
|
|
1611
|
-
* increased for the transaction to be processed.
|
|
1612
|
-
*/
|
|
1613
|
-
declare const DEFAULT_TXN_EXP_SEC_FROM_NOW = 20;
|
|
1614
|
-
/**
|
|
1615
|
-
* The default number of seconds to wait for a transaction to be processed.
|
|
1616
|
-
*
|
|
1617
|
-
* This time is the amount of time that the SDK will wait for a transaction to be processed when waiting for
|
|
1618
|
-
* the results of the transaction. It may take longer based on network connection and network load.
|
|
1619
|
-
*/
|
|
1620
|
-
declare const DEFAULT_TXN_TIMEOUT_SEC = 20;
|
|
1621
|
-
/**
|
|
1622
|
-
* The default gas currency for the network.
|
|
1623
|
-
*/
|
|
1624
|
-
declare const APTOS_COIN = "0x1::aptos_coin::AptosCoin";
|
|
1625
|
-
declare const RAW_TRANSACTION_SALT = "APTOS::RawTransaction";
|
|
1626
|
-
declare const RAW_TRANSACTION_WITH_DATA_SALT = "APTOS::RawTransactionWithData";
|
|
1627
|
-
|
|
1628
|
-
/**
|
|
1629
|
-
* This class holds the config information for the SDK client instance.
|
|
1630
|
-
*/
|
|
1631
|
-
declare class AptosConfig {
|
|
1632
|
-
/** The Network that this SDK is associated with. */
|
|
1633
|
-
readonly network: Network;
|
|
1634
|
-
/**
|
|
1635
|
-
* The client instance the SDK uses
|
|
1636
|
-
*/
|
|
1637
|
-
readonly client: Client;
|
|
1638
|
-
/**
|
|
1639
|
-
* The optional hardcoded fullnode URL to send requests to instead of using the network
|
|
1640
|
-
*/
|
|
1641
|
-
readonly fullnode?: string;
|
|
1642
|
-
/**
|
|
1643
|
-
* The optional hardcoded faucet URL to send requests to instead of using the network
|
|
1644
|
-
*/
|
|
1645
|
-
readonly faucet?: string;
|
|
1646
|
-
/**
|
|
1647
|
-
* The optional hardcoded indexer URL to send requests to instead of using the network
|
|
1648
|
-
*/
|
|
1649
|
-
readonly indexer?: string;
|
|
1650
|
-
readonly clientConfig?: ClientConfig;
|
|
1651
|
-
constructor(settings?: AptosSettings);
|
|
1652
|
-
/**
|
|
1653
|
-
* Returns the URL endpoint to send the request to.
|
|
1654
|
-
* If a custom URL was provided in the config, that URL is returned.
|
|
1655
|
-
* If a custom URL was provided but not URL endpoints, an error is thrown.
|
|
1656
|
-
* Otherwise, the URL endpoint is derived from the network.
|
|
1657
|
-
*
|
|
1658
|
-
* @param apiType - The type of Aptos API to get the URL for.
|
|
1659
|
-
*
|
|
1660
|
-
* @internal
|
|
1661
|
-
*/
|
|
1662
|
-
getRequestUrl(apiType: AptosApiType): string;
|
|
1663
|
-
/**
|
|
1664
|
-
* Checks if the URL is a known indexer endpoint
|
|
1665
|
-
*
|
|
1666
|
-
* @internal
|
|
1667
|
-
* */
|
|
1668
|
-
isIndexerRequest(url: string): boolean;
|
|
1669
|
-
}
|
|
1670
|
-
|
|
1671
|
-
/**
|
|
1672
|
-
* This error is used to explain why parsing failed.
|
|
1673
|
-
*/
|
|
1674
|
-
declare class ParsingError<T> extends Error {
|
|
1675
|
-
/**
|
|
1676
|
-
* This provides a programmatic way to access why parsing failed. Downstream devs
|
|
1677
|
-
* might want to use this to build their own error messages if the default error
|
|
1678
|
-
* messages are not suitable for their use case. This should be an enum.
|
|
1679
|
-
*/
|
|
1680
|
-
invalidReason: T;
|
|
1681
|
-
constructor(message: string, invalidReason: T);
|
|
1682
|
-
}
|
|
1683
|
-
/**
|
|
1684
|
-
* Whereas ParsingError is thrown when parsing fails, e.g. in a fromString function,
|
|
1685
|
-
* this type is returned from "defensive" functions like isValid.
|
|
1686
|
-
*/
|
|
1687
|
-
type ParsingResult<T> = {
|
|
1688
|
-
/**
|
|
1689
|
-
* True if valid, false otherwise.
|
|
1690
|
-
*/
|
|
1691
|
-
valid: boolean;
|
|
1692
|
-
/**
|
|
1693
|
-
* If valid is false, this will be a code explaining why parsing failed.
|
|
1694
|
-
*/
|
|
1695
|
-
invalidReason?: T;
|
|
1696
|
-
/**
|
|
1697
|
-
* If valid is false, this will be a string explaining why parsing failed.
|
|
1698
|
-
*/
|
|
1699
|
-
invalidReasonMessage?: string;
|
|
1700
|
-
};
|
|
1701
|
-
|
|
1702
1635
|
/**
|
|
1703
1636
|
* This enum is used to explain why parsing might have failed.
|
|
1704
1637
|
*/
|
|
@@ -1961,10 +1894,10 @@ declare class Serializer {
|
|
|
1961
1894
|
* @param values The array of BCS Serializable values
|
|
1962
1895
|
* @example
|
|
1963
1896
|
* const addresses = new Array<AccountAddress>(
|
|
1964
|
-
* AccountAddress.
|
|
1965
|
-
* AccountAddress.
|
|
1966
|
-
* AccountAddress.
|
|
1967
|
-
* AccountAddress.
|
|
1897
|
+
* AccountAddress.from("0x1"),
|
|
1898
|
+
* AccountAddress.from("0x2"),
|
|
1899
|
+
* AccountAddress.from("0xa"),
|
|
1900
|
+
* AccountAddress.from("0xb"),
|
|
1968
1901
|
* );
|
|
1969
1902
|
* const serializer = new Serializer();
|
|
1970
1903
|
* serializer.serializeVector(addresses);
|
|
@@ -2104,10 +2037,10 @@ declare class Deserializer {
|
|
|
2104
2037
|
* @example
|
|
2105
2038
|
* // serialize a vector of addresses
|
|
2106
2039
|
* const addresses = new Array<AccountAddress>(
|
|
2107
|
-
* AccountAddress.
|
|
2108
|
-
* AccountAddress.
|
|
2109
|
-
* AccountAddress.
|
|
2110
|
-
* AccountAddress.
|
|
2040
|
+
* AccountAddress.from("0x1"),
|
|
2041
|
+
* AccountAddress.from("0x2"),
|
|
2042
|
+
* AccountAddress.from("0xa"),
|
|
2043
|
+
* AccountAddress.from("0xb"),
|
|
2111
2044
|
* );
|
|
2112
2045
|
* const serializer = new Serializer();
|
|
2113
2046
|
* serializer.serializeVector(addresses);
|
|
@@ -2295,7 +2228,7 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2295
2228
|
static deserialize(deserializer: Deserializer): AccountAddress;
|
|
2296
2229
|
/**
|
|
2297
2230
|
* NOTE: This function has strict parsing behavior. For relaxed behavior, please use
|
|
2298
|
-
* the `
|
|
2231
|
+
* the `fromString` function.
|
|
2299
2232
|
*
|
|
2300
2233
|
* Creates an instance of AccountAddress from a hex string.
|
|
2301
2234
|
*
|
|
@@ -2320,11 +2253,11 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2320
2253
|
*
|
|
2321
2254
|
* @returns An instance of AccountAddress.
|
|
2322
2255
|
*/
|
|
2323
|
-
static
|
|
2256
|
+
static fromStringStrict(input: string): AccountAddress;
|
|
2324
2257
|
/**
|
|
2325
2258
|
* NOTE: This function has relaxed parsing behavior. For strict behavior, please use
|
|
2326
|
-
* the `
|
|
2327
|
-
* function, `
|
|
2259
|
+
* the `fromStringStrict` function. Where possible use `fromStringStrict` rather than this
|
|
2260
|
+
* function, `fromString` is only provided for backwards compatibility.
|
|
2328
2261
|
*
|
|
2329
2262
|
* Creates an instance of AccountAddress from a hex string.
|
|
2330
2263
|
*
|
|
@@ -2346,33 +2279,33 @@ declare class AccountAddress extends Serializable implements TransactionArgument
|
|
|
2346
2279
|
*
|
|
2347
2280
|
* @returns An instance of AccountAddress.
|
|
2348
2281
|
*/
|
|
2349
|
-
static
|
|
2282
|
+
static fromString(input: string): AccountAddress;
|
|
2350
2283
|
/**
|
|
2351
2284
|
* Convenience method for creating an AccountAddress from all known inputs.
|
|
2352
2285
|
*
|
|
2353
2286
|
* This handles, Uint8array, string, and AccountAddress itself
|
|
2354
2287
|
* @param input
|
|
2355
2288
|
*/
|
|
2356
|
-
static
|
|
2289
|
+
static from(input: AccountAddressInput): AccountAddress;
|
|
2357
2290
|
/**
|
|
2358
2291
|
* Convenience method for creating an AccountAddress from all known inputs.
|
|
2359
2292
|
*
|
|
2360
2293
|
* This handles, Uint8array, string, and AccountAddress itself
|
|
2361
2294
|
* @param input
|
|
2362
2295
|
*/
|
|
2363
|
-
static
|
|
2296
|
+
static fromStrict(input: AccountAddressInput): AccountAddress;
|
|
2364
2297
|
/**
|
|
2365
2298
|
* Check if the string is a valid AccountAddress.
|
|
2366
2299
|
*
|
|
2367
2300
|
* @param args.input A hex string representing an account address.
|
|
2368
|
-
* @param args.
|
|
2301
|
+
* @param args.strict If true, use strict parsing behavior. If false, use relaxed parsing behavior.
|
|
2369
2302
|
*
|
|
2370
2303
|
* @returns valid = true if the string is valid, valid = false if not. If the string
|
|
2371
2304
|
* is not valid, invalidReason will be set explaining why it is invalid.
|
|
2372
2305
|
*/
|
|
2373
2306
|
static isValid(args: {
|
|
2374
2307
|
input: AccountAddressInput;
|
|
2375
|
-
|
|
2308
|
+
strict?: boolean;
|
|
2376
2309
|
}): ParsingResult<AddressInvalidReason>;
|
|
2377
2310
|
/**
|
|
2378
2311
|
* Return whether AccountAddresses are equal. AccountAddresses are considered equal
|
|
@@ -3121,6 +3054,7 @@ declare class Ed25519PublicKey extends PublicKey {
|
|
|
3121
3054
|
serialize(serializer: Serializer): void;
|
|
3122
3055
|
static deserialize(deserializer: Deserializer): Ed25519PublicKey;
|
|
3123
3056
|
static load(deserializer: Deserializer): Ed25519PublicKey;
|
|
3057
|
+
static isPublicKey(publicKey: PublicKey): publicKey is Ed25519PublicKey;
|
|
3124
3058
|
}
|
|
3125
3059
|
/**
|
|
3126
3060
|
* Represents the private key of an Ed25519 key pair.
|
|
@@ -3201,6 +3135,7 @@ declare class Ed25519PrivateKey extends PrivateKey {
|
|
|
3201
3135
|
* @returns
|
|
3202
3136
|
*/
|
|
3203
3137
|
private static fromDerivationPathInner;
|
|
3138
|
+
static isPrivateKey(privateKey: PrivateKey): privateKey is Ed25519PrivateKey;
|
|
3204
3139
|
}
|
|
3205
3140
|
/**
|
|
3206
3141
|
* A signature of a message signed using an Ed25519 private key
|
|
@@ -3231,6 +3166,7 @@ declare class Ed25519Signature extends Signature {
|
|
|
3231
3166
|
serialize(serializer: Serializer): void;
|
|
3232
3167
|
static deserialize(deserializer: Deserializer): Ed25519Signature;
|
|
3233
3168
|
static load(deserializer: Deserializer): Ed25519Signature;
|
|
3169
|
+
static isSignature(signature: Signature): signature is Ed25519Signature;
|
|
3234
3170
|
}
|
|
3235
3171
|
|
|
3236
3172
|
/**
|
|
@@ -3386,6 +3322,7 @@ declare class Secp256k1PublicKey extends PublicKey {
|
|
|
3386
3322
|
serialize(serializer: Serializer): void;
|
|
3387
3323
|
static deserialize(deserializer: Deserializer): Secp256k1PublicKey;
|
|
3388
3324
|
static load(deserializer: Deserializer): Secp256k1PublicKey;
|
|
3325
|
+
static isPublicKey(publicKey: PublicKey): publicKey is Secp256k1PublicKey;
|
|
3389
3326
|
}
|
|
3390
3327
|
/**
|
|
3391
3328
|
* A Secp256k1 ecdsa private key
|
|
@@ -3458,6 +3395,7 @@ declare class Secp256k1PrivateKey extends PrivateKey {
|
|
|
3458
3395
|
* @returns The generated key
|
|
3459
3396
|
*/
|
|
3460
3397
|
private static fromDerivationPathInner;
|
|
3398
|
+
static isPrivateKey(privateKey: PrivateKey): privateKey is Secp256k1PrivateKey;
|
|
3461
3399
|
}
|
|
3462
3400
|
/**
|
|
3463
3401
|
* A signature of a message signed using an Secp256k1 ecdsa private key
|
|
@@ -3493,6 +3431,7 @@ declare class Secp256k1Signature extends Signature {
|
|
|
3493
3431
|
serialize(serializer: Serializer): void;
|
|
3494
3432
|
static deserialize(deserializer: Deserializer): Secp256k1Signature;
|
|
3495
3433
|
static load(deserializer: Deserializer): Secp256k1Signature;
|
|
3434
|
+
static isSignature(signature: Signature): signature is Secp256k1Signature;
|
|
3496
3435
|
}
|
|
3497
3436
|
|
|
3498
3437
|
declare class AnySignature extends Signature {
|
|
@@ -3553,6 +3492,9 @@ declare class AnyPublicKey extends PublicKey {
|
|
|
3553
3492
|
}): boolean;
|
|
3554
3493
|
serialize(serializer: Serializer): void;
|
|
3555
3494
|
static deserialize(deserializer: Deserializer): AnyPublicKey;
|
|
3495
|
+
static isPublicKey(publicKey: PublicKey): publicKey is AnyPublicKey;
|
|
3496
|
+
isEd25519(): this is Ed25519PublicKey;
|
|
3497
|
+
isSecp256k1PublicKey(): this is Secp256k1PublicKey;
|
|
3556
3498
|
}
|
|
3557
3499
|
|
|
3558
3500
|
declare class MultiKey extends PublicKey {
|
|
@@ -3657,6 +3599,107 @@ declare const splitPath: (path: string) => Array<string>;
|
|
|
3657
3599
|
*/
|
|
3658
3600
|
declare const mnemonicToSeed: (mnemonic: string) => Uint8Array;
|
|
3659
3601
|
|
|
3602
|
+
/**
|
|
3603
|
+
* Type of API endpoint for request routing
|
|
3604
|
+
*/
|
|
3605
|
+
declare enum AptosApiType {
|
|
3606
|
+
FULLNODE = 0,
|
|
3607
|
+
INDEXER = 1,
|
|
3608
|
+
FAUCET = 2
|
|
3609
|
+
}
|
|
3610
|
+
declare const DEFAULT_NETWORK = Network.DEVNET;
|
|
3611
|
+
/**
|
|
3612
|
+
* The default max gas amount when none is given.
|
|
3613
|
+
*
|
|
3614
|
+
* This is the maximum number of gas units that will be used by a transaction before being rejected.
|
|
3615
|
+
*
|
|
3616
|
+
* Note that max gas amount varies based on the transaction. A larger transaction will go over this
|
|
3617
|
+
* default gas amount, and the value will need to be changed for the specific transaction.
|
|
3618
|
+
*/
|
|
3619
|
+
declare const DEFAULT_MAX_GAS_AMOUNT = 200000;
|
|
3620
|
+
/**
|
|
3621
|
+
* The default transaction expiration seconds from now.
|
|
3622
|
+
*
|
|
3623
|
+
* This time is how long until the blockchain nodes will reject the transaction.
|
|
3624
|
+
*
|
|
3625
|
+
* Note that the transaction expiration time varies based on network connection and network load. It may need to be
|
|
3626
|
+
* increased for the transaction to be processed.
|
|
3627
|
+
*/
|
|
3628
|
+
declare const DEFAULT_TXN_EXP_SEC_FROM_NOW = 20;
|
|
3629
|
+
/**
|
|
3630
|
+
* The default number of seconds to wait for a transaction to be processed.
|
|
3631
|
+
*
|
|
3632
|
+
* This time is the amount of time that the SDK will wait for a transaction to be processed when waiting for
|
|
3633
|
+
* the results of the transaction. It may take longer based on network connection and network load.
|
|
3634
|
+
*/
|
|
3635
|
+
declare const DEFAULT_TXN_TIMEOUT_SEC = 20;
|
|
3636
|
+
/**
|
|
3637
|
+
* The default gas currency for the network.
|
|
3638
|
+
*/
|
|
3639
|
+
declare const APTOS_COIN = "0x1::aptos_coin::AptosCoin";
|
|
3640
|
+
declare const RAW_TRANSACTION_SALT = "APTOS::RawTransaction";
|
|
3641
|
+
declare const RAW_TRANSACTION_WITH_DATA_SALT = "APTOS::RawTransactionWithData";
|
|
3642
|
+
/**
|
|
3643
|
+
* The list of supported Processor types for our indexer api.
|
|
3644
|
+
*
|
|
3645
|
+
* These can be found from the processor_status table in the indexer database.
|
|
3646
|
+
* {@link https://cloud.hasura.io/public/graphiql?endpoint=https://indexer.mainnet.aptoslabs.com/v1/graphql}
|
|
3647
|
+
*/
|
|
3648
|
+
declare enum ProcessorType {
|
|
3649
|
+
ACCOUNT_TRANSACTION_PROCESSOR = "account_transactions_processor",
|
|
3650
|
+
COIN_PROCESSOR = "coin_processor",
|
|
3651
|
+
DEFAULT = "default_processor",
|
|
3652
|
+
EVENTS_PROCESSOR = "events_processor",
|
|
3653
|
+
FUNGIBLE_ASSET_PROCESSOR = "fungible_asset_processor",
|
|
3654
|
+
STAKE_PROCESSOR = "stake_processor",
|
|
3655
|
+
TOKEN_PROCESSOR = "token_processor",
|
|
3656
|
+
TOKEN_V2_PROCESSOR = "token_v2_processor",
|
|
3657
|
+
USER_TRANSACTION_PROCESSOR = "user_transaction_processor"
|
|
3658
|
+
}
|
|
3659
|
+
|
|
3660
|
+
/**
|
|
3661
|
+
* This class holds the config information for the SDK client instance.
|
|
3662
|
+
*/
|
|
3663
|
+
declare class AptosConfig {
|
|
3664
|
+
/** The Network that this SDK is associated with. Defaults to DEVNET */
|
|
3665
|
+
readonly network: Network;
|
|
3666
|
+
/**
|
|
3667
|
+
* The client instance the SDK uses. Defaults to `@aptos-labs/aptos-client
|
|
3668
|
+
*/
|
|
3669
|
+
readonly client: Client;
|
|
3670
|
+
/**
|
|
3671
|
+
* The optional hardcoded fullnode URL to send requests to instead of using the network
|
|
3672
|
+
*/
|
|
3673
|
+
readonly fullnode?: string;
|
|
3674
|
+
/**
|
|
3675
|
+
* The optional hardcoded faucet URL to send requests to instead of using the network
|
|
3676
|
+
*/
|
|
3677
|
+
readonly faucet?: string;
|
|
3678
|
+
/**
|
|
3679
|
+
* The optional hardcoded indexer URL to send requests to instead of using the network
|
|
3680
|
+
*/
|
|
3681
|
+
readonly indexer?: string;
|
|
3682
|
+
readonly clientConfig?: ClientConfig;
|
|
3683
|
+
constructor(settings?: AptosSettings);
|
|
3684
|
+
/**
|
|
3685
|
+
* Returns the URL endpoint to send the request to.
|
|
3686
|
+
* If a custom URL was provided in the config, that URL is returned.
|
|
3687
|
+
* If a custom URL was provided but not URL endpoints, an error is thrown.
|
|
3688
|
+
* Otherwise, the URL endpoint is derived from the network.
|
|
3689
|
+
*
|
|
3690
|
+
* @param apiType - The type of Aptos API to get the URL for.
|
|
3691
|
+
*
|
|
3692
|
+
* @internal
|
|
3693
|
+
*/
|
|
3694
|
+
getRequestUrl(apiType: AptosApiType): string;
|
|
3695
|
+
/**
|
|
3696
|
+
* Checks if the URL is a known indexer endpoint
|
|
3697
|
+
*
|
|
3698
|
+
* @internal
|
|
3699
|
+
* */
|
|
3700
|
+
isIndexerRequest(url: string): boolean;
|
|
3701
|
+
}
|
|
3702
|
+
|
|
3660
3703
|
/**
|
|
3661
3704
|
* A class to query all `Account` related queries on Aptos.
|
|
3662
3705
|
*/
|
|
@@ -3696,7 +3739,7 @@ declare class Account {
|
|
|
3696
3739
|
*/
|
|
3697
3740
|
getAccountModules(args: {
|
|
3698
3741
|
accountAddress: AccountAddressInput;
|
|
3699
|
-
options?: PaginationArgs &
|
|
3742
|
+
options?: PaginationArgs & LedgerVersionArg;
|
|
3700
3743
|
}): Promise<MoveModuleBytecode[]>;
|
|
3701
3744
|
/**
|
|
3702
3745
|
* Queries for a specific account module given account address and module name
|
|
@@ -3718,7 +3761,7 @@ declare class Account {
|
|
|
3718
3761
|
getAccountModule(args: {
|
|
3719
3762
|
accountAddress: AccountAddressInput;
|
|
3720
3763
|
moduleName: string;
|
|
3721
|
-
options?:
|
|
3764
|
+
options?: LedgerVersionArg;
|
|
3722
3765
|
}): Promise<MoveModuleBytecode>;
|
|
3723
3766
|
/**
|
|
3724
3767
|
* Queries account transactions given an account address
|
|
@@ -3750,7 +3793,7 @@ declare class Account {
|
|
|
3750
3793
|
*/
|
|
3751
3794
|
getAccountResources(args: {
|
|
3752
3795
|
accountAddress: AccountAddressInput;
|
|
3753
|
-
options?: PaginationArgs &
|
|
3796
|
+
options?: PaginationArgs & LedgerVersionArg;
|
|
3754
3797
|
}): Promise<MoveResource[]>;
|
|
3755
3798
|
/**
|
|
3756
3799
|
* Queries a specific account resource given account address and resource type. Note that the default is `any` in order
|
|
@@ -3766,14 +3809,14 @@ declare class Account {
|
|
|
3766
3809
|
* @example An example of an account resource
|
|
3767
3810
|
* ```
|
|
3768
3811
|
* {
|
|
3769
|
-
*
|
|
3812
|
+
* value: 6
|
|
3770
3813
|
* }
|
|
3771
3814
|
* ```
|
|
3772
3815
|
*/
|
|
3773
3816
|
getAccountResource<T extends {} = any>(args: {
|
|
3774
3817
|
accountAddress: AccountAddressInput;
|
|
3775
3818
|
resourceType: MoveStructId;
|
|
3776
|
-
options?:
|
|
3819
|
+
options?: LedgerVersionArg;
|
|
3777
3820
|
}): Promise<T>;
|
|
3778
3821
|
/**
|
|
3779
3822
|
* Looks up the account address for a given authentication key
|
|
@@ -3781,21 +3824,25 @@ declare class Account {
|
|
|
3781
3824
|
* This handles both if the account's authentication key has been rotated or not.
|
|
3782
3825
|
*
|
|
3783
3826
|
* @param args.authenticationKey The authentication key
|
|
3827
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3784
3828
|
* @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
|
|
3785
3829
|
* @returns Promise<AccountAddress> The accountAddress associated with the authentication key
|
|
3786
3830
|
*/
|
|
3787
3831
|
lookupOriginalAccountAddress(args: {
|
|
3788
3832
|
authenticationKey: AccountAddressInput;
|
|
3789
|
-
|
|
3833
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3834
|
+
options?: LedgerVersionArg;
|
|
3790
3835
|
}): Promise<AccountAddress>;
|
|
3791
3836
|
/**
|
|
3792
3837
|
* Queries the current count of tokens owned by an account
|
|
3793
3838
|
*
|
|
3794
3839
|
* @param args.accountAddress The account address
|
|
3840
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3795
3841
|
* @returns Current count of tokens owned by the account
|
|
3796
3842
|
*/
|
|
3797
3843
|
getAccountTokensCount(args: {
|
|
3798
3844
|
accountAddress: AccountAddressInput;
|
|
3845
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3799
3846
|
}): Promise<number>;
|
|
3800
3847
|
/**
|
|
3801
3848
|
* Queries the account's current owned tokens.
|
|
@@ -3804,19 +3851,17 @@ declare class Account {
|
|
|
3804
3851
|
* If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
|
|
3805
3852
|
*
|
|
3806
3853
|
* @param args.accountAddress The account address we want to get the tokens for
|
|
3854
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3807
3855
|
* @param args.options.tokenStandard The NFT standard to query for
|
|
3808
|
-
* @param args.options.
|
|
3809
|
-
* @param args.options.
|
|
3856
|
+
* @param args.options.offset The number token to start returning results from
|
|
3857
|
+
* @param args.options.limit The number of results to return
|
|
3810
3858
|
* @param args.options.orderBy The order to sort the tokens by
|
|
3811
3859
|
* @returns Tokens array with the token data
|
|
3812
3860
|
*/
|
|
3813
3861
|
getAccountOwnedTokens(args: {
|
|
3814
3862
|
accountAddress: AccountAddressInput;
|
|
3815
|
-
|
|
3816
|
-
|
|
3817
|
-
pagination?: PaginationArgs;
|
|
3818
|
-
orderBy?: OrderBy<GetAccountOwnedTokensQueryResponse[0]>;
|
|
3819
|
-
};
|
|
3863
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3864
|
+
options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountOwnedTokensQueryResponse[0]>;
|
|
3820
3865
|
}): Promise<GetAccountOwnedTokensQueryResponse>;
|
|
3821
3866
|
/**
|
|
3822
3867
|
* Queries all current tokens of a specific collection that an account owns by the collection address
|
|
@@ -3826,20 +3871,18 @@ declare class Account {
|
|
|
3826
3871
|
*
|
|
3827
3872
|
* @param args.accountAddress The account address we want to get the tokens for
|
|
3828
3873
|
* @param args.collectionAddress The address of the collection being queried
|
|
3874
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3829
3875
|
* @param args.options.tokenStandard The NFT standard to query for
|
|
3830
|
-
* @param args.options.
|
|
3831
|
-
* @param args.options.
|
|
3876
|
+
* @param args.options.offset The number token to start returning results from
|
|
3877
|
+
* @param args.options.limit The number of results to return
|
|
3832
3878
|
* @param args.options.orderBy The order to sort the tokens by
|
|
3833
3879
|
* @returns Tokens array with the token data
|
|
3834
3880
|
*/
|
|
3835
3881
|
getAccountOwnedTokensFromCollectionAddress(args: {
|
|
3836
3882
|
accountAddress: AccountAddressInput;
|
|
3837
3883
|
collectionAddress: AccountAddressInput;
|
|
3838
|
-
|
|
3839
|
-
|
|
3840
|
-
pagination?: PaginationArgs;
|
|
3841
|
-
orderBy?: OrderBy<GetAccountOwnedTokensFromCollectionResponse[0]>;
|
|
3842
|
-
};
|
|
3884
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3885
|
+
options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountOwnedTokensFromCollectionResponse[0]>;
|
|
3843
3886
|
}): Promise<GetAccountOwnedTokensFromCollectionResponse>;
|
|
3844
3887
|
/**
|
|
3845
3888
|
* Queries for all collections that an account currently has tokens for.
|
|
@@ -3848,70 +3891,95 @@ declare class Account {
|
|
|
3848
3891
|
* If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
|
|
3849
3892
|
*
|
|
3850
3893
|
* @param args.accountAddress The account address we want to get the collections for
|
|
3894
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3851
3895
|
* @param args.options.tokenStandard The NFT standard to query for
|
|
3852
|
-
* @param args.options.
|
|
3853
|
-
* @param args.options.
|
|
3896
|
+
* @param args.options.offset The number collection to start returning results from
|
|
3897
|
+
* @param args.options.limit The number of results to return
|
|
3854
3898
|
* @param args.options.orderBy The order to sort the tokens by
|
|
3855
3899
|
* @returns Collections array with the collections data
|
|
3856
3900
|
*/
|
|
3857
3901
|
getAccountCollectionsWithOwnedTokens(args: {
|
|
3858
3902
|
accountAddress: AccountAddressInput;
|
|
3859
|
-
|
|
3860
|
-
|
|
3861
|
-
pagination?: PaginationArgs;
|
|
3862
|
-
orderBy?: OrderBy<GetAccountCollectionsWithOwnedTokenResponse[0]>;
|
|
3863
|
-
};
|
|
3903
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3904
|
+
options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountCollectionsWithOwnedTokenResponse[0]>;
|
|
3864
3905
|
}): Promise<GetAccountCollectionsWithOwnedTokenResponse>;
|
|
3865
3906
|
/**
|
|
3866
3907
|
* Queries the current count of transactions submitted by an account
|
|
3867
3908
|
*
|
|
3868
3909
|
* @param args.accountAddress The account address we want to get the total count for
|
|
3910
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3869
3911
|
* @returns Current count of transactions made by an account
|
|
3870
3912
|
*/
|
|
3871
3913
|
getAccountTransactionsCount(args: {
|
|
3872
3914
|
accountAddress: AccountAddressInput;
|
|
3915
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3873
3916
|
}): Promise<number>;
|
|
3874
3917
|
/**
|
|
3875
3918
|
* Queries an account's coins data
|
|
3876
3919
|
*
|
|
3877
3920
|
* @param args.accountAddress The account address we want to get the coins data for
|
|
3878
|
-
* @param args.
|
|
3879
|
-
* @param args.options.
|
|
3880
|
-
* @param args.options.
|
|
3921
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3922
|
+
* @param args.options.offset optional. The number coin to start returning results from
|
|
3923
|
+
* @param args.options.limit optional. The number of results to return
|
|
3924
|
+
* @param args.options.orderBy optional. The order to sort the coins by
|
|
3925
|
+
* @param args.options.where optional. Filter the results by
|
|
3881
3926
|
* @returns Array with the coins data
|
|
3882
3927
|
*/
|
|
3883
3928
|
getAccountCoinsData(args: {
|
|
3884
3929
|
accountAddress: AccountAddressInput;
|
|
3885
|
-
|
|
3886
|
-
|
|
3887
|
-
orderBy?: OrderBy<GetAccountCoinsDataResponse[0]>;
|
|
3888
|
-
};
|
|
3930
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3931
|
+
options?: PaginationArgs & OrderByArg<GetAccountCoinsDataResponse[0]> & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
|
|
3889
3932
|
}): Promise<GetAccountCoinsDataResponse>;
|
|
3890
3933
|
/**
|
|
3891
3934
|
* Queries the current count of an account's coins aggregated
|
|
3892
3935
|
*
|
|
3893
3936
|
* @param args.accountAddress The account address we want to get the total count for
|
|
3937
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3894
3938
|
* @returns Current count of the aggregated count of all account's coins
|
|
3895
3939
|
*/
|
|
3896
3940
|
getAccountCoinsCount(args: {
|
|
3897
3941
|
accountAddress: AccountAddressInput;
|
|
3942
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3898
3943
|
}): Promise<number>;
|
|
3899
3944
|
/**
|
|
3900
|
-
* Queries
|
|
3945
|
+
* Queries the account's APT amount
|
|
3901
3946
|
*
|
|
3902
|
-
* @param args.accountAddress The account address we want to get the
|
|
3903
|
-
* @param args.
|
|
3904
|
-
* @
|
|
3905
|
-
* @param args.options.orderBy The order to sort the coins by
|
|
3906
|
-
* @returns Objects array with the object data
|
|
3947
|
+
* @param args.accountAddress The account address we want to get the total count for
|
|
3948
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3949
|
+
* @returns Current amount of account's APT
|
|
3907
3950
|
*/
|
|
3908
|
-
|
|
3951
|
+
getAccountAPTAmount(args: {
|
|
3909
3952
|
accountAddress: AccountAddressInput;
|
|
3910
|
-
|
|
3911
|
-
|
|
3912
|
-
|
|
3913
|
-
|
|
3914
|
-
|
|
3953
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3954
|
+
}): Promise<number>;
|
|
3955
|
+
/**
|
|
3956
|
+
* Queries the account's coin amount by the coin type
|
|
3957
|
+
*
|
|
3958
|
+
* @param args.accountAddress The account address we want to get the total count for
|
|
3959
|
+
* @param args.coinType The coin type to query
|
|
3960
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3961
|
+
* @returns Current amount of account's coin
|
|
3962
|
+
*/
|
|
3963
|
+
getAccountCoinAmount(args: {
|
|
3964
|
+
accountAddress: AccountAddressInput;
|
|
3965
|
+
coinType: MoveStructId;
|
|
3966
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3967
|
+
}): Promise<number>;
|
|
3968
|
+
/**
|
|
3969
|
+
* Queries an account's owned objects
|
|
3970
|
+
*
|
|
3971
|
+
* @param args.accountAddress The account address we want to get the objects for
|
|
3972
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
3973
|
+
* @param args.options.offset The starting position to start returning results from
|
|
3974
|
+
* @param args.options.limit The number of results to return
|
|
3975
|
+
* @param args.options.orderBy The order to sort the objects by
|
|
3976
|
+
* @returns Objects array with the object data
|
|
3977
|
+
*/
|
|
3978
|
+
getAccountOwnedObjects(args: {
|
|
3979
|
+
accountAddress: AccountAddressInput;
|
|
3980
|
+
minimumLedgerVersion?: AnyNumber;
|
|
3981
|
+
options?: PaginationArgs & OrderByArg<GetAccountOwnedObjectsResponse[0]>;
|
|
3982
|
+
}): Promise<GetAccountOwnedObjectsResponse>;
|
|
3915
3983
|
/**
|
|
3916
3984
|
* Derives an account by providing a private key.
|
|
3917
3985
|
* This functions resolves the provided private key type and derives the public key from it.
|
|
@@ -4388,6 +4456,10 @@ declare class RotationProofChallenge extends Serializable {
|
|
|
4388
4456
|
declare abstract class AccountAuthenticator extends Serializable {
|
|
4389
4457
|
abstract serialize(serializer: Serializer): void;
|
|
4390
4458
|
static deserialize(deserializer: Deserializer): AccountAuthenticator;
|
|
4459
|
+
isEd25519(): this is AccountAuthenticatorEd25519;
|
|
4460
|
+
isMultiEd25519(): this is AccountAuthenticatorMultiEd25519;
|
|
4461
|
+
isSingleKey(): this is AccountAuthenticatorSingleKey;
|
|
4462
|
+
isMultiKey(): this is AccountAuthenticatorMultiKey;
|
|
4391
4463
|
}
|
|
4392
4464
|
/**
|
|
4393
4465
|
* Transaction authenticator Ed25519 for a multi signer transaction
|
|
@@ -4554,7 +4626,7 @@ declare class SignedTransaction extends Serializable {
|
|
|
4554
4626
|
/**
|
|
4555
4627
|
* Entry function arguments to be used when building a raw transaction using remote ABI
|
|
4556
4628
|
*/
|
|
4557
|
-
type SimpleEntryFunctionArgumentTypes = boolean | number | bigint | string | null | undefined | Uint8Array | Array<SimpleEntryFunctionArgumentTypes>;
|
|
4629
|
+
type SimpleEntryFunctionArgumentTypes = boolean | number | bigint | string | null | undefined | Uint8Array | Array<SimpleEntryFunctionArgumentTypes | EntryFunctionArgumentTypes>;
|
|
4558
4630
|
/**
|
|
4559
4631
|
* Entry function arguments to be used when building a raw transaction using BCS serialized arguments
|
|
4560
4632
|
*/
|
|
@@ -4601,7 +4673,7 @@ type InputEntryFunctionDataWithRemoteABI = InputEntryFunctionData & {
|
|
|
4601
4673
|
* The data needed to generate a Multi Sig payload
|
|
4602
4674
|
*/
|
|
4603
4675
|
type InputMultiSigData = {
|
|
4604
|
-
multisigAddress:
|
|
4676
|
+
multisigAddress: AccountAddressInput;
|
|
4605
4677
|
} & InputEntryFunctionData;
|
|
4606
4678
|
/**
|
|
4607
4679
|
* The data needed to generate a Multi Sig payload
|
|
@@ -4829,15 +4901,15 @@ declare class DigitalAsset {
|
|
|
4829
4901
|
*
|
|
4830
4902
|
* @param args.creatorAddress the address of the collection's creator
|
|
4831
4903
|
* @param args.collectionName the name of the collection
|
|
4904
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
4832
4905
|
* @param args.options.tokenStandard the token standard to query
|
|
4833
4906
|
* @returns GetCollectionDataResponse response type
|
|
4834
4907
|
*/
|
|
4835
4908
|
getCollectionData(args: {
|
|
4836
4909
|
creatorAddress: AccountAddressInput;
|
|
4837
4910
|
collectionName: string;
|
|
4838
|
-
|
|
4839
|
-
|
|
4840
|
-
};
|
|
4911
|
+
minimumLedgerVersion?: AnyNumber;
|
|
4912
|
+
options?: TokenStandardArg;
|
|
4841
4913
|
}): Promise<GetCollectionDataResponse>;
|
|
4842
4914
|
/**
|
|
4843
4915
|
* Queries a collection's ID.
|
|
@@ -4847,15 +4919,15 @@ declare class DigitalAsset {
|
|
|
4847
4919
|
*
|
|
4848
4920
|
* @param args.creatorAddress the address of the collection's creator
|
|
4849
4921
|
* @param args.collectionName the name of the collection
|
|
4922
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
4850
4923
|
* @param args.options.tokenStandard the token standard to query
|
|
4851
4924
|
* @returns the collection id
|
|
4852
4925
|
*/
|
|
4853
4926
|
getCollectionId(args: {
|
|
4854
4927
|
creatorAddress: AccountAddressInput;
|
|
4855
4928
|
collectionName: string;
|
|
4856
|
-
|
|
4857
|
-
|
|
4858
|
-
};
|
|
4929
|
+
minimumLedgerVersion?: AnyNumber;
|
|
4930
|
+
options?: TokenStandardArg;
|
|
4859
4931
|
}): Promise<string>;
|
|
4860
4932
|
/**
|
|
4861
4933
|
* Create a transaction to mint a token into the creators account within an existing collection.
|
|
@@ -4880,46 +4952,68 @@ declare class DigitalAsset {
|
|
|
4880
4952
|
* Gets token data given the address of a token.
|
|
4881
4953
|
*
|
|
4882
4954
|
* @param args.tokenAddress The address of the token
|
|
4955
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
4883
4956
|
* @returns GetTokenDataResponse containing relevant data to the token.
|
|
4884
4957
|
*/
|
|
4885
4958
|
getTokenData(args: {
|
|
4886
4959
|
tokenAddress: AccountAddressInput;
|
|
4960
|
+
minimumLedgerVersion?: AnyNumber;
|
|
4887
4961
|
}): Promise<GetTokenDataResponse>;
|
|
4888
4962
|
/**
|
|
4889
4963
|
* Gets token ownership data given the address of a token.
|
|
4890
4964
|
*
|
|
4891
4965
|
* @param args.tokenAddress The address of the token
|
|
4966
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
4892
4967
|
* @returns GetCurrentTokenOwnershipResponse containing relevant ownership data of the token.
|
|
4893
4968
|
*/
|
|
4894
4969
|
getCurrentTokenOwnership(args: {
|
|
4895
4970
|
tokenAddress: AccountAddressInput;
|
|
4971
|
+
minimumLedgerVersion?: AnyNumber;
|
|
4896
4972
|
}): Promise<GetCurrentTokenOwnershipResponse>;
|
|
4897
4973
|
/**
|
|
4898
4974
|
* Gets the tokens that the given address owns.
|
|
4899
4975
|
*
|
|
4900
4976
|
* @param args.ownerAddress The address of the owner
|
|
4977
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
4901
4978
|
* @returns GetOwnedTokensResponse containing ownership data of the tokens belonging to the ownerAddresss.
|
|
4902
4979
|
*/
|
|
4903
4980
|
getOwnedTokens(args: {
|
|
4904
4981
|
ownerAddress: AccountAddressInput;
|
|
4905
|
-
|
|
4906
|
-
|
|
4907
|
-
orderBy?: OrderBy<GetOwnedTokensResponse[0]>;
|
|
4908
|
-
};
|
|
4982
|
+
minimumLedgerVersion?: AnyNumber;
|
|
4983
|
+
options?: PaginationArgs & OrderByArg<GetOwnedTokensResponse[0]>;
|
|
4909
4984
|
}): Promise<GetOwnedTokensResponse>;
|
|
4910
4985
|
/**
|
|
4911
4986
|
* Gets the activity data given the address of a token.
|
|
4912
4987
|
*
|
|
4913
4988
|
* @param args.tokenAddress The address of the token
|
|
4989
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
4914
4990
|
* @returns GetTokenActivityResponse containing relevant activity data to the token.
|
|
4915
4991
|
*/
|
|
4916
4992
|
getTokenActivity(args: {
|
|
4917
4993
|
tokenAddress: AccountAddressInput;
|
|
4918
|
-
|
|
4919
|
-
|
|
4920
|
-
orderBy?: OrderBy<GetTokenActivityResponse[0]>;
|
|
4921
|
-
};
|
|
4994
|
+
minimumLedgerVersion?: AnyNumber;
|
|
4995
|
+
options?: PaginationArgs & OrderByArg<GetTokenActivityResponse[0]>;
|
|
4922
4996
|
}): Promise<GetTokenActivityResponse>;
|
|
4997
|
+
/**
|
|
4998
|
+
* Transfer a digital asset (non fungible token) ownership.
|
|
4999
|
+
*
|
|
5000
|
+
* We can transfer a digital asset only when the digital asset is not frozen
|
|
5001
|
+
* (i.e. owner transfer is not disabled such as for soul bound tokens)
|
|
5002
|
+
*
|
|
5003
|
+
* @param args.sender The sender account of the current digital asset owner
|
|
5004
|
+
* @param args.digitalAssetAddress The digital asset address
|
|
5005
|
+
* @param args.recipient The recipient account address
|
|
5006
|
+
* @param args.digitalAssetType optional. The digital asset type, default to "0x4::token::Token"
|
|
5007
|
+
*
|
|
5008
|
+
* @returns A SingleSignerTransaction that can be simulated or submitted to chain
|
|
5009
|
+
*/
|
|
5010
|
+
transferDigitalAsset(args: {
|
|
5011
|
+
sender: Account$1;
|
|
5012
|
+
digitalAssetAddress: AccountAddressInput;
|
|
5013
|
+
recipient: AccountAddress;
|
|
5014
|
+
digitalAssetType?: MoveStructId;
|
|
5015
|
+
options?: InputGenerateTransactionOptions;
|
|
5016
|
+
}): Promise<SingleSignerTransaction>;
|
|
4923
5017
|
}
|
|
4924
5018
|
|
|
4925
5019
|
/**
|
|
@@ -4933,34 +5027,35 @@ declare class Event {
|
|
|
4933
5027
|
*
|
|
4934
5028
|
* @param args.accountAddress - The account address
|
|
4935
5029
|
* @param args.creationNumber - The event creation number
|
|
5030
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
4936
5031
|
*
|
|
4937
5032
|
* @returns Promise<GetEventsResponse>
|
|
4938
5033
|
*/
|
|
4939
5034
|
getAccountEventsByCreationNumber(args: {
|
|
4940
5035
|
accountAddress: AccountAddressInput;
|
|
4941
5036
|
creationNumber: AnyNumber;
|
|
5037
|
+
minimumLedgerVersion?: AnyNumber;
|
|
4942
5038
|
}): Promise<GetEventsResponse>;
|
|
4943
5039
|
/**
|
|
4944
5040
|
* Get events by event type and an account address
|
|
4945
5041
|
*
|
|
4946
5042
|
* @param args.accountAddress - The account address
|
|
4947
5043
|
* @param args.eventType - The event type
|
|
5044
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
4948
5045
|
*
|
|
4949
5046
|
* @returns Promise<GetEventsResponse>
|
|
4950
5047
|
*/
|
|
4951
5048
|
getAccountEventsByEventType(args: {
|
|
4952
5049
|
accountAddress: AccountAddressInput;
|
|
4953
5050
|
eventType: MoveStructId;
|
|
4954
|
-
|
|
4955
|
-
|
|
4956
|
-
orderBy?: OrderBy<GetEventsResponse[0]>;
|
|
4957
|
-
};
|
|
5051
|
+
minimumLedgerVersion?: AnyNumber;
|
|
5052
|
+
options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
|
|
4958
5053
|
}): Promise<GetEventsResponse>;
|
|
4959
5054
|
/**
|
|
4960
5055
|
* Get all events
|
|
4961
5056
|
*
|
|
4962
5057
|
* An optional `where` can be passed in to filter out the response.
|
|
4963
|
-
|
|
5058
|
+
*@param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
4964
5059
|
* @example
|
|
4965
5060
|
* ```
|
|
4966
5061
|
* { where:
|
|
@@ -4973,11 +5068,8 @@ declare class Event {
|
|
|
4973
5068
|
* @returns GetEventsQuery response type
|
|
4974
5069
|
*/
|
|
4975
5070
|
getEvents(args?: {
|
|
4976
|
-
|
|
4977
|
-
|
|
4978
|
-
pagination?: PaginationArgs;
|
|
4979
|
-
orderBy?: OrderBy<GetEventsResponse[0]>;
|
|
4980
|
-
};
|
|
5071
|
+
minimumLedgerVersion?: AnyNumber;
|
|
5072
|
+
options?: PaginationArgs & OrderByArg<GetEventsResponse[0]> & WhereArg<EventsBoolExp>;
|
|
4981
5073
|
}): Promise<GetEventsResponse>;
|
|
4982
5074
|
}
|
|
4983
5075
|
|
|
@@ -5000,8 +5092,185 @@ declare class Faucet {
|
|
|
5000
5092
|
accountAddress: AccountAddressInput;
|
|
5001
5093
|
amount: number;
|
|
5002
5094
|
options?: WaitForTransactionOptions;
|
|
5003
|
-
}): Promise<
|
|
5095
|
+
}): Promise<UserTransactionResponse>;
|
|
5096
|
+
}
|
|
5097
|
+
|
|
5098
|
+
declare function isBool(arg: SimpleEntryFunctionArgumentTypes): arg is boolean;
|
|
5099
|
+
declare function isString(arg: any): arg is string;
|
|
5100
|
+
declare function isNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number;
|
|
5101
|
+
declare function isLargeNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number | bigint | string;
|
|
5102
|
+
declare function isNull(arg: SimpleEntryFunctionArgumentTypes): arg is null | undefined;
|
|
5103
|
+
declare function isEncodedEntryFunctionArgument(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is EntryFunctionArgumentTypes;
|
|
5104
|
+
declare function isBcsBool(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is Bool;
|
|
5105
|
+
declare function isBcsAddress(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is AccountAddress;
|
|
5106
|
+
declare function isBcsString(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is MoveString;
|
|
5107
|
+
declare function isBcsFixedBytes(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is FixedBytes;
|
|
5108
|
+
declare function isBcsU8(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U8;
|
|
5109
|
+
declare function isBcsU16(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U16;
|
|
5110
|
+
declare function isBcsU32(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U32;
|
|
5111
|
+
declare function isBcsU64(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U64;
|
|
5112
|
+
declare function isBcsU128(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U128;
|
|
5113
|
+
declare function isBcsU256(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U256;
|
|
5114
|
+
declare function isScriptDataInput(arg: InputGenerateTransactionPayloadDataWithRemoteABI | InputGenerateTransactionPayloadData): arg is InputScriptData;
|
|
5115
|
+
declare function throwTypeMismatch(expectedType: string, position: number): void;
|
|
5116
|
+
/**
|
|
5117
|
+
* Finds first non-signer arg.
|
|
5118
|
+
*
|
|
5119
|
+
* A function is often defined with a `signer` or `&signer` arguments at the start, which are filled in
|
|
5120
|
+
* by signatures, and not by the caller.
|
|
5121
|
+
* @param functionAbi
|
|
5122
|
+
*/
|
|
5123
|
+
declare function findFirstNonSignerArg(functionAbi: MoveFunction): number;
|
|
5124
|
+
declare function getFunctionParts(functionArg: MoveFunctionId): {
|
|
5125
|
+
moduleAddress: string;
|
|
5126
|
+
moduleName: string;
|
|
5127
|
+
functionName: string;
|
|
5128
|
+
};
|
|
5129
|
+
|
|
5130
|
+
/**
|
|
5131
|
+
* We are defining function signatures, each with its specific input and output.
|
|
5132
|
+
* These are the possible function signature for our `generateTransactionPayload` function.
|
|
5133
|
+
* When we call our `generateTransactionPayload` function with the relevant type properties,
|
|
5134
|
+
* Typescript can infer the return type based on the appropriate function overload.
|
|
5135
|
+
*/
|
|
5136
|
+
declare function generateTransactionPayload(args: InputScriptData): Promise<TransactionPayloadScript>;
|
|
5137
|
+
declare function generateTransactionPayload(args: InputEntryFunctionDataWithRemoteABI): Promise<TransactionPayloadEntryFunction>;
|
|
5138
|
+
declare function generateTransactionPayload(args: InputMultiSigDataWithRemoteABI): Promise<TransactionPayloadMultisig>;
|
|
5139
|
+
declare function generateTransactionPayloadWithABI(args: InputEntryFunctionData, functionAbi: EntryFunctionABI): TransactionPayloadEntryFunction;
|
|
5140
|
+
declare function generateTransactionPayloadWithABI(args: InputMultiSigData, functionAbi: EntryFunctionABI): TransactionPayloadMultisig;
|
|
5141
|
+
/**
|
|
5142
|
+
* Generates a raw transaction
|
|
5143
|
+
*
|
|
5144
|
+
* @param args.aptosConfig AptosConfig
|
|
5145
|
+
* @param args.sender The transaction's sender account address as a hex input
|
|
5146
|
+
* @param args.payload The transaction payload - can create by using generateTransactionPayload()
|
|
5147
|
+
*
|
|
5148
|
+
* @returns RawTransaction
|
|
5149
|
+
*/
|
|
5150
|
+
declare function generateRawTransaction(args: {
|
|
5151
|
+
aptosConfig: AptosConfig;
|
|
5152
|
+
sender: AccountAddressInput;
|
|
5153
|
+
payload: AnyTransactionPayloadInstance;
|
|
5154
|
+
options?: InputGenerateTransactionOptions;
|
|
5155
|
+
}): Promise<RawTransaction>;
|
|
5156
|
+
/**
|
|
5157
|
+
* We are defining function signatures, each with its specific input and output.
|
|
5158
|
+
* These are the possible function signature for our `generateTransaction` function.
|
|
5159
|
+
* When we call our `generateTransaction` function with the relevant type properties,
|
|
5160
|
+
* Typescript can infer the return type based on the appropriate function overload.
|
|
5161
|
+
*/
|
|
5162
|
+
declare function buildTransaction(args: InputGenerateSingleSignerRawTransactionArgs): Promise<SingleSignerTransaction>;
|
|
5163
|
+
declare function buildTransaction(args: InputGenerateMultiAgentRawTransactionArgs): Promise<MultiAgentTransaction>;
|
|
5164
|
+
/**
|
|
5165
|
+
* Simulate a transaction before signing and submit to chain
|
|
5166
|
+
*
|
|
5167
|
+
* @param args.transaction A aptos transaction type to sign
|
|
5168
|
+
* @param args.signerPublicKey The signer public key
|
|
5169
|
+
* @param args.secondarySignersPublicKeys optional. The secondary signers public keys if multi signers transaction
|
|
5170
|
+
* @param args.feePayerPublicKey optional. The fee payer public key is a fee payer (aka sponsored) transaction
|
|
5171
|
+
* @param args.options optional. SimulateTransactionOptions
|
|
5172
|
+
*
|
|
5173
|
+
* @returns A signed serialized transaction that can be simulated
|
|
5174
|
+
*/
|
|
5175
|
+
declare function generateSignedTransactionForSimulation(args: InputSimulateTransactionData): Uint8Array;
|
|
5176
|
+
declare function getAuthenticatorForSimulation(publicKey: PublicKey): AccountAuthenticatorEd25519 | AccountAuthenticatorSingleKey;
|
|
5177
|
+
/**
|
|
5178
|
+
* Sign a transaction that can later be submitted to chain
|
|
5179
|
+
*
|
|
5180
|
+
* @param args.signer The signer account to sign the transaction
|
|
5181
|
+
* @param args.transaction A aptos transaction type to sign
|
|
5182
|
+
*
|
|
5183
|
+
* @return The signer AccountAuthenticator
|
|
5184
|
+
*/
|
|
5185
|
+
declare function sign(args: {
|
|
5186
|
+
signer: Account$1;
|
|
5187
|
+
transaction: AnyRawTransaction;
|
|
5188
|
+
}): AccountAuthenticator;
|
|
5189
|
+
/**
|
|
5190
|
+
* Prepare a transaction to be submitted to chain
|
|
5191
|
+
*
|
|
5192
|
+
* @param args.transaction A aptos transaction type
|
|
5193
|
+
* @param args.senderAuthenticator The account authenticator of the transaction sender
|
|
5194
|
+
* @param args.secondarySignerAuthenticators optional. For when the transaction is a multi signers transaction
|
|
5195
|
+
*
|
|
5196
|
+
* @returns A SignedTransaction
|
|
5197
|
+
*/
|
|
5198
|
+
declare function generateSignedTransaction(args: InputSubmitTransactionData): Uint8Array;
|
|
5199
|
+
/**
|
|
5200
|
+
* Derive the raw transaction type - FeePayerRawTransaction or MultiAgentRawTransaction or RawTransaction
|
|
5201
|
+
*
|
|
5202
|
+
* @param transaction A aptos transaction type
|
|
5203
|
+
*
|
|
5204
|
+
* @returns FeePayerRawTransaction | MultiAgentRawTransaction | RawTransaction
|
|
5205
|
+
*/
|
|
5206
|
+
declare function deriveTransactionType(transaction: AnyRawTransaction): AnyRawTransactionInstance;
|
|
5207
|
+
/**
|
|
5208
|
+
* Generate a multi signers signed transaction that can be submitted to chain
|
|
5209
|
+
*
|
|
5210
|
+
* @param transaction MultiAgentRawTransaction | FeePayerRawTransaction
|
|
5211
|
+
* @param senderAuthenticator The account authenticator of the transaction sender
|
|
5212
|
+
* @param secondarySignerAuthenticators The extra signers account Authenticators
|
|
5213
|
+
*
|
|
5214
|
+
* @returns A SignedTransaction
|
|
5215
|
+
*/
|
|
5216
|
+
declare function generateMultiSignersSignedTransaction(transaction: MultiAgentRawTransaction | FeePayerRawTransaction, senderAuthenticator: AccountAuthenticator, feePayerAuthenticator?: AccountAuthenticator, additionalSignersAuthenticators?: Array<AccountAuthenticator>): Uint8Array;
|
|
5217
|
+
declare function generateSigningMessage(transaction: AnyRawTransaction): Uint8Array;
|
|
5218
|
+
|
|
5219
|
+
/**
|
|
5220
|
+
* Convert type arguments to only type tags, allowing for string representations of type tags
|
|
5221
|
+
*/
|
|
5222
|
+
declare function standardizeTypeTags(typeArguments?: Array<TypeTag | string>): Array<TypeTag>;
|
|
5223
|
+
/**
|
|
5224
|
+
* Fetches the ABI for an entry function from the module
|
|
5225
|
+
*
|
|
5226
|
+
* @param moduleAddress
|
|
5227
|
+
* @param moduleName
|
|
5228
|
+
* @param functionName
|
|
5229
|
+
* @param aptosConfig
|
|
5230
|
+
*/
|
|
5231
|
+
declare function fetchEntryFunctionAbi(moduleAddress: string, moduleName: string, functionName: string, aptosConfig: AptosConfig): Promise<EntryFunctionABI>;
|
|
5232
|
+
/**
|
|
5233
|
+
* Converts a non-BCS encoded argument into BCS encoded, if necessary
|
|
5234
|
+
* @param functionName
|
|
5235
|
+
* @param functionAbi
|
|
5236
|
+
* @param arg
|
|
5237
|
+
* @param position
|
|
5238
|
+
*/
|
|
5239
|
+
declare function convertArgument(functionName: string, functionAbi: EntryFunctionABI, arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes, position: number, genericTypeParams: Array<TypeTag>): EntryFunctionArgumentTypes;
|
|
5240
|
+
declare function checkOrConvertArgument(arg: SimpleEntryFunctionArgumentTypes | EntryFunctionArgumentTypes, param: TypeTag, position: number, genericTypeParams: Array<TypeTag>): EntryFunctionArgumentTypes;
|
|
5241
|
+
|
|
5242
|
+
declare enum TypeTagParserErrorType {
|
|
5243
|
+
InvalidTypeTag = "unknown type",
|
|
5244
|
+
UnexpectedGenericType = "unexpected generic type",
|
|
5245
|
+
UnexpectedTypeArgumentClose = "unexpected '>'",
|
|
5246
|
+
UnexpectedWhitespaceCharacter = "unexpected whitespace character",
|
|
5247
|
+
UnexpectedComma = "unexpected ','",
|
|
5248
|
+
TypeArgumentCountMismatch = "type argument count doesn't match expected amount",
|
|
5249
|
+
MissingTypeArgumentClose = "no matching '>' for '<'",
|
|
5250
|
+
UnexpectedPrimitiveTypeArguments = "primitive types not expected to have type arguments",
|
|
5251
|
+
UnexpectedVectorTypeArgumentCount = "vector type expected to have exactly one type argument",
|
|
5252
|
+
UnexpectedStructFormat = "unexpected struct format, must be of the form 0xaddress::module_name::struct_name",
|
|
5253
|
+
InvalidModuleNameCharacter = "module name must only contain alphanumeric or '_' characters",
|
|
5254
|
+
InvalidStructNameCharacter = "struct name must only contain alphanumeric or '_' characters"
|
|
5255
|
+
}
|
|
5256
|
+
declare class TypeTagParserError extends Error {
|
|
5257
|
+
constructor(typeTagStr: string, invalidReason: TypeTagParserErrorType);
|
|
5004
5258
|
}
|
|
5259
|
+
/**
|
|
5260
|
+
* All types are made of a few parts they're either:
|
|
5261
|
+
* 1. A simple type e.g. u8
|
|
5262
|
+
* 2. A standalone struct e.g. 0x1::account::Account
|
|
5263
|
+
* 3. A nested struct e.g. 0x1::coin::Coin<0x1234::coin::MyCoin>
|
|
5264
|
+
*
|
|
5265
|
+
* There are a few more special cases that need to be handled, however.
|
|
5266
|
+
* 1. Multiple generics e.g 0x1::pair::Pair<u8, u16>
|
|
5267
|
+
* 2. Spacing in the generics e.g. 0x1::pair::Pair< u8 , u16>
|
|
5268
|
+
* 3. Nested generics of different depths e.g. 0x1::pair::Pair<0x1::coin::Coin<0x1234::coin::MyCoin>, u8>
|
|
5269
|
+
* 4. Generics for types in ABIs are filled in with placeholders e.g T1, T2, T3
|
|
5270
|
+
*/
|
|
5271
|
+
declare function parseTypeTag(typeStr: string, options?: {
|
|
5272
|
+
allowGenerics?: boolean;
|
|
5273
|
+
}): TypeTag;
|
|
5005
5274
|
|
|
5006
5275
|
/**
|
|
5007
5276
|
* A class to query all `FungibleAsset` related queries on Aptos.
|
|
@@ -5010,60 +5279,75 @@ declare class FungibleAsset {
|
|
|
5010
5279
|
readonly config: AptosConfig;
|
|
5011
5280
|
constructor(config: AptosConfig);
|
|
5012
5281
|
/**
|
|
5013
|
-
* Queries
|
|
5282
|
+
* Queries all fungible asset metadata.
|
|
5014
5283
|
*
|
|
5015
|
-
*
|
|
5016
|
-
* It can be filtered by creator address and asset type.
|
|
5284
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
5017
5285
|
*
|
|
5018
|
-
* @returns
|
|
5286
|
+
* @returns A list of fungible asset metadata
|
|
5019
5287
|
*/
|
|
5020
5288
|
getFungibleAssetMetadata(args?: {
|
|
5021
|
-
|
|
5022
|
-
|
|
5023
|
-
where?: FungibleAssetMetadataBoolExp;
|
|
5024
|
-
};
|
|
5289
|
+
minimumLedgerVersion?: AnyNumber;
|
|
5290
|
+
options?: PaginationArgs & WhereArg<FungibleAssetMetadataBoolExp>;
|
|
5025
5291
|
}): Promise<GetFungibleAssetMetadataResponse>;
|
|
5026
5292
|
/**
|
|
5027
|
-
* Queries
|
|
5293
|
+
* Queries a fungible asset metadata
|
|
5028
5294
|
*
|
|
5029
5295
|
* This query returns the fungible asset metadata for a specific fungible asset.
|
|
5030
5296
|
*
|
|
5031
|
-
* @param
|
|
5297
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
5298
|
+
* @param args.assetType The asset type of the fungible asset.
|
|
5032
5299
|
* e.g
|
|
5033
5300
|
* "0x1::aptos_coin::AptosCoin" for Aptos Coin
|
|
5034
5301
|
* "0xc2948283c2ce03aafbb294821de7ee684b06116bb378ab614fa2de07a99355a8" - address format if this is fungible asset
|
|
5035
5302
|
*
|
|
5036
|
-
* @returns
|
|
5303
|
+
* @returns A fungible asset metadata item
|
|
5037
5304
|
*/
|
|
5038
|
-
getFungibleAssetMetadataByAssetType(
|
|
5305
|
+
getFungibleAssetMetadataByAssetType(args: {
|
|
5306
|
+
assetType: string;
|
|
5307
|
+
minimumLedgerVersion?: AnyNumber;
|
|
5308
|
+
}): Promise<GetFungibleAssetMetadataResponse[0]>;
|
|
5039
5309
|
/**
|
|
5040
|
-
* Queries
|
|
5310
|
+
* Queries all fungible asset activities
|
|
5041
5311
|
*
|
|
5042
|
-
*
|
|
5043
|
-
* It can be filtered by owner address, asset type, and type.
|
|
5312
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
5044
5313
|
*
|
|
5045
|
-
* @returns
|
|
5314
|
+
* @returns A list of fungible asset metadata
|
|
5046
5315
|
*/
|
|
5047
5316
|
getFungibleAssetActivities(args?: {
|
|
5048
|
-
|
|
5049
|
-
|
|
5050
|
-
where?: FungibleAssetActivitiesBoolExp;
|
|
5051
|
-
};
|
|
5317
|
+
minimumLedgerVersion?: AnyNumber;
|
|
5318
|
+
options?: PaginationArgs & WhereArg<FungibleAssetActivitiesBoolExp>;
|
|
5052
5319
|
}): Promise<GetFungibleAssetActivitiesResponse>;
|
|
5053
5320
|
/**
|
|
5054
|
-
* Queries
|
|
5321
|
+
* Queries all fungible asset balances
|
|
5055
5322
|
*
|
|
5056
|
-
*
|
|
5057
|
-
* It can be filtered by owner address, and asset type
|
|
5323
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
5058
5324
|
*
|
|
5059
|
-
* @returns
|
|
5325
|
+
* @returns A list of fungible asset metadata
|
|
5060
5326
|
*/
|
|
5061
5327
|
getCurrentFungibleAssetBalances(args?: {
|
|
5062
|
-
|
|
5063
|
-
|
|
5064
|
-
where?: CurrentFungibleAssetBalancesBoolExp;
|
|
5065
|
-
};
|
|
5328
|
+
minimumLedgerVersion?: AnyNumber;
|
|
5329
|
+
options?: PaginationArgs & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
|
|
5066
5330
|
}): Promise<GetCurrentFungibleAssetBalancesResponse>;
|
|
5331
|
+
/**
|
|
5332
|
+
* Transfer `amount` of fungible asset from sender's primary store to recipient's primary store.
|
|
5333
|
+
*
|
|
5334
|
+
* Use this method to transfer any fungible asset including fungible token.
|
|
5335
|
+
*
|
|
5336
|
+
* @param sender The sender account
|
|
5337
|
+
* @param fungibleAssetMetadataAddress The fungible asset account address.
|
|
5338
|
+
* For example if you’re transferring USDT this would be the USDT address
|
|
5339
|
+
* @param recipient The recipient account address
|
|
5340
|
+
* @param amount Number of assets to transfer
|
|
5341
|
+
*
|
|
5342
|
+
* @returns A SingleSignerTransaction that can be simulated or submitted to chain.
|
|
5343
|
+
*/
|
|
5344
|
+
transferFungibleAsset(args: {
|
|
5345
|
+
sender: Account$1;
|
|
5346
|
+
fungibleAssetMetadataAddress: AccountAddress;
|
|
5347
|
+
recipient: AccountAddress;
|
|
5348
|
+
amount: AnyNumber;
|
|
5349
|
+
options?: InputGenerateTransactionOptions;
|
|
5350
|
+
}): Promise<SingleSignerTransaction>;
|
|
5067
5351
|
}
|
|
5068
5352
|
|
|
5069
5353
|
/**
|
|
@@ -5146,7 +5430,7 @@ declare class General {
|
|
|
5146
5430
|
getTableItem<T>(args: {
|
|
5147
5431
|
handle: string;
|
|
5148
5432
|
data: TableItemRequest;
|
|
5149
|
-
options?:
|
|
5433
|
+
options?: LedgerVersionArg;
|
|
5150
5434
|
}): Promise<T>;
|
|
5151
5435
|
/**
|
|
5152
5436
|
* Queries for a Move view function
|
|
@@ -5165,7 +5449,7 @@ declare class General {
|
|
|
5165
5449
|
*/
|
|
5166
5450
|
view<T extends Array<MoveValue>>(args: {
|
|
5167
5451
|
payload: InputViewRequestData;
|
|
5168
|
-
options?:
|
|
5452
|
+
options?: LedgerVersionArg;
|
|
5169
5453
|
}): Promise<T>;
|
|
5170
5454
|
/**
|
|
5171
5455
|
* Queries top user transactions
|
|
@@ -5205,6 +5489,13 @@ declare class General {
|
|
|
5205
5489
|
* This is useful to tell what ledger version the indexer is updated to, as it can be behind the full nodes.
|
|
5206
5490
|
*/
|
|
5207
5491
|
getIndexerLastSuccessVersion(): Promise<number>;
|
|
5492
|
+
/**
|
|
5493
|
+
* Query the processor status for a specific processor type.
|
|
5494
|
+
*
|
|
5495
|
+
* @param processorType The processor type to query
|
|
5496
|
+
* @returns
|
|
5497
|
+
*/
|
|
5498
|
+
getProcessorStatus(processorType: ProcessorType): Promise<GetProcessorStatusResponse[0]>;
|
|
5208
5499
|
}
|
|
5209
5500
|
|
|
5210
5501
|
/**
|
|
@@ -5225,7 +5516,7 @@ interface RegisterNameParameters {
|
|
|
5225
5516
|
policy: "subdomain:follow-domain";
|
|
5226
5517
|
} | {
|
|
5227
5518
|
policy: "subdomain:independent";
|
|
5228
|
-
expirationDate:
|
|
5519
|
+
expirationDate: number;
|
|
5229
5520
|
};
|
|
5230
5521
|
transferable?: boolean;
|
|
5231
5522
|
toAddress?: AccountAddressInput;
|
|
@@ -5233,11 +5524,7 @@ interface RegisterNameParameters {
|
|
|
5233
5524
|
options?: InputGenerateTransactionOptions;
|
|
5234
5525
|
}
|
|
5235
5526
|
interface QueryNamesOptions {
|
|
5236
|
-
options?:
|
|
5237
|
-
pagination?: PaginationArgs;
|
|
5238
|
-
orderBy?: OrderBy<GetANSNameResponse[0]>;
|
|
5239
|
-
where?: CurrentAptosNamesBoolExp;
|
|
5240
|
-
};
|
|
5527
|
+
options?: PaginationArgs & OrderByArg<GetANSNameResponse[0]> & WhereArg<CurrentAptosNamesBoolExp>;
|
|
5241
5528
|
}
|
|
5242
5529
|
interface GetAccountNamesArgs extends QueryNamesOptions {
|
|
5243
5530
|
accountAddress: AccountAddressInput;
|
|
@@ -5285,7 +5572,7 @@ declare class ANS {
|
|
|
5285
5572
|
*
|
|
5286
5573
|
* @param args.name - A string of the name to retrieve
|
|
5287
5574
|
*
|
|
5288
|
-
* @returns number as a unix timestamp in
|
|
5575
|
+
* @returns number as a unix timestamp in milliseconds.
|
|
5289
5576
|
*/
|
|
5290
5577
|
getExpiration(args: {
|
|
5291
5578
|
name: string;
|
|
@@ -5313,9 +5600,9 @@ declare class ANS {
|
|
|
5313
5600
|
* point to addresses that are not the owner of the name
|
|
5314
5601
|
*
|
|
5315
5602
|
* ```ts
|
|
5316
|
-
* await aptos.setTargetAddress({sender: alice, name: "test.aptos", address: bob.accountAddress
|
|
5603
|
+
* await aptos.setTargetAddress({sender: alice, name: "test.aptos", address: bob.accountAddress})
|
|
5317
5604
|
* const address = await aptos.getTargetAddress({name: "test.aptos"})
|
|
5318
|
-
* // address = bob.accountAddress
|
|
5605
|
+
* // address = bob.accountAddress
|
|
5319
5606
|
* ```
|
|
5320
5607
|
*
|
|
5321
5608
|
* @param args.name - A string of the name: test.aptos.apt, test.apt, test, test.aptos, etc.
|
|
@@ -5335,7 +5622,7 @@ declare class ANS {
|
|
|
5335
5622
|
* account also may not have a primary name.
|
|
5336
5623
|
*
|
|
5337
5624
|
* ```ts
|
|
5338
|
-
* const name = await aptos.getPrimaryName({address: alice.accountAddress
|
|
5625
|
+
* const name = await aptos.getPrimaryName({address: alice.accountAddress})
|
|
5339
5626
|
* // name = test.aptos
|
|
5340
5627
|
* ```
|
|
5341
5628
|
*
|
|
@@ -5353,7 +5640,7 @@ declare class ANS {
|
|
|
5353
5640
|
*
|
|
5354
5641
|
* ```ts
|
|
5355
5642
|
* await aptos.setPrimaryName({sender: alice, name: "test.aptos"})
|
|
5356
|
-
* const primaryName = await aptos.getPrimaryName({address: alice.accountAddress
|
|
5643
|
+
* const primaryName = await aptos.getPrimaryName({address: alice.accountAddress})
|
|
5357
5644
|
* // primaryName = test.aptos
|
|
5358
5645
|
* ```
|
|
5359
5646
|
*
|
|
@@ -5364,7 +5651,7 @@ declare class ANS {
|
|
|
5364
5651
|
*/
|
|
5365
5652
|
setPrimaryName(args: {
|
|
5366
5653
|
sender: Account$1;
|
|
5367
|
-
name
|
|
5654
|
+
name?: string;
|
|
5368
5655
|
options?: InputGenerateTransactionOptions;
|
|
5369
5656
|
}): Promise<SingleSignerTransaction>;
|
|
5370
5657
|
/**
|
|
@@ -5378,7 +5665,7 @@ declare class ANS {
|
|
|
5378
5665
|
* name: "test.aptos.apt",
|
|
5379
5666
|
* expiration: {
|
|
5380
5667
|
* policy: "subdomain:independent",
|
|
5381
|
-
* expirationDate:
|
|
5668
|
+
* expirationDate: Date.now() + 30 * 24 * 60 * 60 * 1000,
|
|
5382
5669
|
* },
|
|
5383
5670
|
* });
|
|
5384
5671
|
* ```
|
|
@@ -5391,8 +5678,9 @@ declare class ANS {
|
|
|
5391
5678
|
* - domain: Years is required and the name will expire after the given number of years.
|
|
5392
5679
|
* - subdomain:follow-domain: The name will expire at the same time as the domain name.
|
|
5393
5680
|
* - subdomain:independent: The name will expire at the given date.
|
|
5394
|
-
* @param args.expiration.expirationDate -
|
|
5395
|
-
* the
|
|
5681
|
+
* @param args.expiration.expirationDate - An epoch number in milliseconds of
|
|
5682
|
+
* the date when the subdomain will expire. Only applicable when the policy is
|
|
5683
|
+
* set to 'subdomain:independent'.
|
|
5396
5684
|
* @param args.transferable - Determines if the subdomain being minted is soul-bound. Applicable only to subdomains.
|
|
5397
5685
|
* @param args.targetAddress optional - The address the domain name will resolve to. If not provided,
|
|
5398
5686
|
* the sender's address will be used.
|
|
@@ -5441,8 +5729,8 @@ declare class ANS {
|
|
|
5441
5729
|
*
|
|
5442
5730
|
* @param args
|
|
5443
5731
|
* @param args.accountAddress - A AccountAddressInput of the address to retrieve names for.
|
|
5444
|
-
* @param args.options.
|
|
5445
|
-
* @param args.options.
|
|
5732
|
+
* @param args.options.offset - Optional, the offset to start from when fetching names
|
|
5733
|
+
* @param args.options.limit - Optional, A number of the names to fetch per request
|
|
5446
5734
|
* @param args.options.orderBy - The order to sort the names by
|
|
5447
5735
|
* @param args.options.where - Additional filters to apply to the query
|
|
5448
5736
|
*
|
|
@@ -5454,8 +5742,8 @@ declare class ANS {
|
|
|
5454
5742
|
*
|
|
5455
5743
|
* @param args
|
|
5456
5744
|
* @param args.accountAddress - A AccountAddressInput of the address to retrieve domain names for.
|
|
5457
|
-
* @param args.options.
|
|
5458
|
-
* @param args.options.
|
|
5745
|
+
* @param args.options.offset - Optional, the offset to start from when fetching names
|
|
5746
|
+
* @param args.options.limit - Optional, A number of the names to fetch per request
|
|
5459
5747
|
* @param args.options.orderBy - The order to sort the names by
|
|
5460
5748
|
* @param args.options.where - Additional filters to apply to the query
|
|
5461
5749
|
*
|
|
@@ -5467,8 +5755,8 @@ declare class ANS {
|
|
|
5467
5755
|
*
|
|
5468
5756
|
* @param args
|
|
5469
5757
|
* @param args.accountAddress - A AccountAddressInput of the address to retrieve subdomains names for.
|
|
5470
|
-
* @param args.options.
|
|
5471
|
-
* @param args.options.
|
|
5758
|
+
* @param args.options.offset - Optional, the offset to start from when fetching names
|
|
5759
|
+
* @param args.options.limit - Optional, A number of the names to fetch per request
|
|
5472
5760
|
* @param args.options.orderBy - The order to sort the names by
|
|
5473
5761
|
* @param args.options.where - Additional filters to apply to the query
|
|
5474
5762
|
*
|
|
@@ -5480,8 +5768,8 @@ declare class ANS {
|
|
|
5480
5768
|
*
|
|
5481
5769
|
* @param args
|
|
5482
5770
|
* @param args.domain - A string of the domain name: eg. "test.apt" or "test" (without the suffix of .apt)
|
|
5483
|
-
* @param args.options.
|
|
5484
|
-
* @param args.options.
|
|
5771
|
+
* @param args.options.offset - Optional, the offset to start from when fetching names
|
|
5772
|
+
* @param args.options.limit - Optional, A number of the names to fetch per request
|
|
5485
5773
|
* @param args.options.orderBy - The order to sort the names by
|
|
5486
5774
|
* @param args.options.where - Additional filters to apply to the query
|
|
5487
5775
|
*
|
|
@@ -5500,31 +5788,35 @@ declare class Staking {
|
|
|
5500
5788
|
* Queries current number of delegators in a pool. Throws an error if the pool is not found.
|
|
5501
5789
|
*
|
|
5502
5790
|
* @param args.poolAddress Pool address
|
|
5791
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
5503
5792
|
* @returns The number of delegators for the given pool
|
|
5504
5793
|
*/
|
|
5505
5794
|
getNumberOfDelegators(args: {
|
|
5506
5795
|
poolAddress: AccountAddressInput;
|
|
5796
|
+
minimumLedgerVersion?: AnyNumber;
|
|
5507
5797
|
}): Promise<number>;
|
|
5508
5798
|
/**
|
|
5509
5799
|
* Queries current number of delegators in a pool. Throws an error if the pool is not found.
|
|
5510
5800
|
*
|
|
5801
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
5511
5802
|
* @returns GetNumberOfDelegatorsForAllPoolsResponse response type
|
|
5512
5803
|
*/
|
|
5513
5804
|
getNumberOfDelegatorsForAllPools(args?: {
|
|
5514
|
-
|
|
5515
|
-
|
|
5516
|
-
};
|
|
5805
|
+
minimumLedgerVersion?: AnyNumber;
|
|
5806
|
+
options?: OrderByArg<GetNumberOfDelegatorsResponse[0]>;
|
|
5517
5807
|
}): Promise<GetNumberOfDelegatorsResponse>;
|
|
5518
5808
|
/**
|
|
5519
5809
|
* Queries delegated staking activities
|
|
5520
5810
|
*
|
|
5521
5811
|
* @param args.delegatorAddress Delegator address
|
|
5522
5812
|
* @param args.poolAddress Pool address
|
|
5813
|
+
* @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
|
|
5523
5814
|
* @returns GetDelegatedStakingActivitiesResponse response type
|
|
5524
5815
|
*/
|
|
5525
5816
|
getDelegatedStakingActivities(args: {
|
|
5526
5817
|
delegatorAddress: AccountAddressInput;
|
|
5527
5818
|
poolAddress: AccountAddressInput;
|
|
5819
|
+
minimumLedgerVersion?: AnyNumber;
|
|
5528
5820
|
}): Promise<GetDelegatedStakingActivitiesResponse>;
|
|
5529
5821
|
}
|
|
5530
5822
|
|
|
@@ -5601,7 +5893,7 @@ declare class Transaction {
|
|
|
5601
5893
|
waitForTransaction(args: {
|
|
5602
5894
|
transactionHash: HexInput;
|
|
5603
5895
|
options?: WaitForTransactionOptions;
|
|
5604
|
-
}): Promise<
|
|
5896
|
+
}): Promise<CommittedTransactionResponse>;
|
|
5605
5897
|
/**
|
|
5606
5898
|
* Gives an estimate of the gas unit price required to get a
|
|
5607
5899
|
* transaction on chain in a reasonable amount of time.
|
|
@@ -5618,11 +5910,42 @@ declare class Transaction {
|
|
|
5618
5910
|
* ```
|
|
5619
5911
|
*/
|
|
5620
5912
|
getGasPriceEstimation(): Promise<GasEstimation>;
|
|
5913
|
+
/**
|
|
5914
|
+
* Returns a signing message for a transaction.
|
|
5915
|
+
*
|
|
5916
|
+
* This allows a user to sign a transaction using their own preferred signing method, and
|
|
5917
|
+
* then submit it to the network.
|
|
5918
|
+
* @param args.transaction A raw transaction for signing elsewhere
|
|
5919
|
+
*/
|
|
5920
|
+
getSigningMessage(args: {
|
|
5921
|
+
transaction: AnyRawTransaction;
|
|
5922
|
+
}): Uint8Array;
|
|
5621
5923
|
}
|
|
5622
5924
|
|
|
5623
5925
|
declare class TransactionSubmission {
|
|
5624
5926
|
readonly config: AptosConfig;
|
|
5625
5927
|
constructor(config: AptosConfig);
|
|
5928
|
+
/**
|
|
5929
|
+
* Batch transactions for a single account.
|
|
5930
|
+
*
|
|
5931
|
+
* This function uses a transaction worker that receives payloads to be processed
|
|
5932
|
+
* and submitted to chain.
|
|
5933
|
+
* Note that this process is best for submitting multiple transactions that
|
|
5934
|
+
* dont rely on each other, i.e batch funds, batch token mints, etc.
|
|
5935
|
+
*
|
|
5936
|
+
* If any worker failure, the functions throws an error.
|
|
5937
|
+
*
|
|
5938
|
+
* @param args.sender The sender account to sign and submit the transaction
|
|
5939
|
+
* @param args.data An array of transaction payloads
|
|
5940
|
+
* @param args.options optional. Transaction generation configurations (excluding accountSequenceNumber)
|
|
5941
|
+
*
|
|
5942
|
+
* @return void. Throws if any error
|
|
5943
|
+
*/
|
|
5944
|
+
batchTransactionsForSingleAccount(args: {
|
|
5945
|
+
sender: Account$1;
|
|
5946
|
+
data: InputGenerateTransactionPayloadData[];
|
|
5947
|
+
options?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">;
|
|
5948
|
+
}): Promise<void>;
|
|
5626
5949
|
/**
|
|
5627
5950
|
* Sign and submit a single signer transaction to chain
|
|
5628
5951
|
*
|
|
@@ -5677,181 +6000,6 @@ declare class TransactionSubmission {
|
|
|
5677
6000
|
}): Promise<TransactionResponse>;
|
|
5678
6001
|
}
|
|
5679
6002
|
|
|
5680
|
-
declare function isBool(arg: SimpleEntryFunctionArgumentTypes): arg is boolean;
|
|
5681
|
-
declare function isString(arg: any): arg is string;
|
|
5682
|
-
declare function isNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number;
|
|
5683
|
-
declare function isLargeNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number | bigint | string;
|
|
5684
|
-
declare function isNull(arg: SimpleEntryFunctionArgumentTypes): arg is null | undefined;
|
|
5685
|
-
declare function isBcsBool(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is Bool;
|
|
5686
|
-
declare function isBcsAddress(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is AccountAddress;
|
|
5687
|
-
declare function isBcsString(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is MoveString;
|
|
5688
|
-
declare function isBcsFixedBytes(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is FixedBytes;
|
|
5689
|
-
declare function isBcsU8(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U8;
|
|
5690
|
-
declare function isBcsU16(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U16;
|
|
5691
|
-
declare function isBcsU32(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U32;
|
|
5692
|
-
declare function isBcsU64(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U64;
|
|
5693
|
-
declare function isBcsU128(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U128;
|
|
5694
|
-
declare function isBcsU256(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U256;
|
|
5695
|
-
declare function isScriptDataInput(arg: InputGenerateTransactionPayloadDataWithRemoteABI | InputGenerateTransactionPayloadData): arg is InputScriptData;
|
|
5696
|
-
declare function throwTypeMismatch(expectedType: string, position: number): void;
|
|
5697
|
-
/**
|
|
5698
|
-
* Finds first non-signer arg.
|
|
5699
|
-
*
|
|
5700
|
-
* A function is often defined with a `signer` or `&signer` arguments at the start, which are filled in
|
|
5701
|
-
* by signatures, and not by the caller.
|
|
5702
|
-
* @param functionAbi
|
|
5703
|
-
*/
|
|
5704
|
-
declare function findFirstNonSignerArg(functionAbi: MoveFunction): number;
|
|
5705
|
-
declare function getFunctionParts(functionArg: MoveFunctionId): {
|
|
5706
|
-
moduleAddress: string;
|
|
5707
|
-
moduleName: string;
|
|
5708
|
-
functionName: string;
|
|
5709
|
-
};
|
|
5710
|
-
|
|
5711
|
-
/**
|
|
5712
|
-
* We are defining function signatures, each with its specific input and output.
|
|
5713
|
-
* These are the possible function signature for our `generateTransactionPayload` function.
|
|
5714
|
-
* When we call our `generateTransactionPayload` function with the relevant type properties,
|
|
5715
|
-
* Typescript can infer the return type based on the appropriate function overload.
|
|
5716
|
-
*/
|
|
5717
|
-
declare function generateTransactionPayload(args: InputScriptData): Promise<TransactionPayloadScript>;
|
|
5718
|
-
declare function generateTransactionPayload(args: InputEntryFunctionDataWithRemoteABI): Promise<TransactionPayloadEntryFunction>;
|
|
5719
|
-
declare function generateTransactionPayload(args: InputMultiSigDataWithRemoteABI): Promise<TransactionPayloadMultisig>;
|
|
5720
|
-
declare function generateTransactionPayloadWithABI(args: InputEntryFunctionData, functionAbi: EntryFunctionABI): TransactionPayloadEntryFunction;
|
|
5721
|
-
declare function generateTransactionPayloadWithABI(args: InputMultiSigData, functionAbi: EntryFunctionABI): TransactionPayloadMultisig;
|
|
5722
|
-
/**
|
|
5723
|
-
* Generates a raw transaction
|
|
5724
|
-
*
|
|
5725
|
-
* @param args.aptosConfig AptosConfig
|
|
5726
|
-
* @param args.sender The transaction's sender account address as a hex input
|
|
5727
|
-
* @param args.payload The transaction payload - can create by using generateTransactionPayload()
|
|
5728
|
-
*
|
|
5729
|
-
* @returns RawTransaction
|
|
5730
|
-
*/
|
|
5731
|
-
declare function generateRawTransaction(args: {
|
|
5732
|
-
aptosConfig: AptosConfig;
|
|
5733
|
-
sender: AccountAddressInput;
|
|
5734
|
-
payload: AnyTransactionPayloadInstance;
|
|
5735
|
-
options?: InputGenerateTransactionOptions;
|
|
5736
|
-
}): Promise<RawTransaction>;
|
|
5737
|
-
/**
|
|
5738
|
-
* We are defining function signatures, each with its specific input and output.
|
|
5739
|
-
* These are the possible function signature for our `generateTransaction` function.
|
|
5740
|
-
* When we call our `generateTransaction` function with the relevant type properties,
|
|
5741
|
-
* Typescript can infer the return type based on the appropriate function overload.
|
|
5742
|
-
*/
|
|
5743
|
-
declare function buildTransaction(args: InputGenerateSingleSignerRawTransactionArgs): Promise<SingleSignerTransaction>;
|
|
5744
|
-
declare function buildTransaction(args: InputGenerateMultiAgentRawTransactionArgs): Promise<MultiAgentTransaction>;
|
|
5745
|
-
/**
|
|
5746
|
-
* Simulate a transaction before signing and submit to chain
|
|
5747
|
-
*
|
|
5748
|
-
* @param args.transaction A aptos transaction type to sign
|
|
5749
|
-
* @param args.signerPublicKey The signer public key
|
|
5750
|
-
* @param args.secondarySignersPublicKeys optional. The secondary signers public keys if multi signers transaction
|
|
5751
|
-
* @param args.feePayerPublicKey optional. The fee payer public key is a fee payer (aka sponsored) transaction
|
|
5752
|
-
* @param args.options optional. SimulateTransactionOptions
|
|
5753
|
-
*
|
|
5754
|
-
* @returns A signed serialized transaction that can be simulated
|
|
5755
|
-
*/
|
|
5756
|
-
declare function generateSignedTransactionForSimulation(args: InputSimulateTransactionData): Uint8Array;
|
|
5757
|
-
declare function getAuthenticatorForSimulation(publicKey: PublicKey): AccountAuthenticatorEd25519 | AccountAuthenticatorSingleKey;
|
|
5758
|
-
/**
|
|
5759
|
-
* Sign a transaction that can later be submitted to chain
|
|
5760
|
-
*
|
|
5761
|
-
* @param args.signer The signer account to sign the transaction
|
|
5762
|
-
* @param args.transaction A aptos transaction type to sign
|
|
5763
|
-
*
|
|
5764
|
-
* @return The signer AccountAuthenticator
|
|
5765
|
-
*/
|
|
5766
|
-
declare function sign(args: {
|
|
5767
|
-
signer: Account$1;
|
|
5768
|
-
transaction: AnyRawTransaction;
|
|
5769
|
-
}): AccountAuthenticator;
|
|
5770
|
-
/**
|
|
5771
|
-
* Prepare a transaction to be submitted to chain
|
|
5772
|
-
*
|
|
5773
|
-
* @param args.transaction A aptos transaction type
|
|
5774
|
-
* @param args.senderAuthenticator The account authenticator of the transaction sender
|
|
5775
|
-
* @param args.secondarySignerAuthenticators optional. For when the transaction is a multi signers transaction
|
|
5776
|
-
*
|
|
5777
|
-
* @returns A SignedTransaction
|
|
5778
|
-
*/
|
|
5779
|
-
declare function generateSignedTransaction(args: InputSubmitTransactionData): Uint8Array;
|
|
5780
|
-
/**
|
|
5781
|
-
* Derive the raw transaction type - FeePayerRawTransaction or MultiAgentRawTransaction or RawTransaction
|
|
5782
|
-
*
|
|
5783
|
-
* @param transaction A aptos transaction type
|
|
5784
|
-
*
|
|
5785
|
-
* @returns FeePayerRawTransaction | MultiAgentRawTransaction | RawTransaction
|
|
5786
|
-
*/
|
|
5787
|
-
declare function deriveTransactionType(transaction: AnyRawTransaction): AnyRawTransactionInstance;
|
|
5788
|
-
/**
|
|
5789
|
-
* Generate a multi signers signed transaction that can be submitted to chain
|
|
5790
|
-
*
|
|
5791
|
-
* @param transaction MultiAgentRawTransaction | FeePayerRawTransaction
|
|
5792
|
-
* @param senderAuthenticator The account authenticator of the transaction sender
|
|
5793
|
-
* @param secondarySignerAuthenticators The extra signers account Authenticators
|
|
5794
|
-
*
|
|
5795
|
-
* @returns A SignedTransaction
|
|
5796
|
-
*/
|
|
5797
|
-
declare function generateMultiSignersSignedTransaction(transaction: MultiAgentRawTransaction | FeePayerRawTransaction, senderAuthenticator: AccountAuthenticator, feePayerAuthenticator?: AccountAuthenticator, additionalSignersAuthenticators?: Array<AccountAuthenticator>): Uint8Array;
|
|
5798
|
-
declare function getSigningMessage(rawTxn: AnyRawTransactionInstance): Uint8Array;
|
|
5799
|
-
|
|
5800
|
-
/**
|
|
5801
|
-
* Convert type arguments to only type tags, allowing for string representations of type tags
|
|
5802
|
-
*/
|
|
5803
|
-
declare function standardizeTypeTags(typeArguments?: Array<TypeTag | string>): Array<TypeTag>;
|
|
5804
|
-
/**
|
|
5805
|
-
* Fetches the ABI for an entry function from the module
|
|
5806
|
-
*
|
|
5807
|
-
* @param moduleAddress
|
|
5808
|
-
* @param moduleName
|
|
5809
|
-
* @param functionName
|
|
5810
|
-
* @param aptosConfig
|
|
5811
|
-
*/
|
|
5812
|
-
declare function fetchEntryFunctionAbi(moduleAddress: string, moduleName: string, functionName: string, aptosConfig: AptosConfig): Promise<EntryFunctionABI>;
|
|
5813
|
-
/**
|
|
5814
|
-
* Converts a non-BCS encoded argument into BCS encoded, if necessary
|
|
5815
|
-
* @param functionName
|
|
5816
|
-
* @param functionAbi
|
|
5817
|
-
* @param arg
|
|
5818
|
-
* @param position
|
|
5819
|
-
*/
|
|
5820
|
-
declare function convertArgument(functionName: string, functionAbi: EntryFunctionABI, arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes, position: number, genericTypeParams: Array<TypeTag>): EntryFunctionArgumentTypes;
|
|
5821
|
-
|
|
5822
|
-
declare enum TypeTagParserErrorType {
|
|
5823
|
-
InvalidTypeTag = "unknown type",
|
|
5824
|
-
UnexpectedGenericType = "unexpected generic type",
|
|
5825
|
-
UnexpectedTypeArgumentClose = "unexpected '>'",
|
|
5826
|
-
UnexpectedWhitespaceCharacter = "unexpected whitespace character",
|
|
5827
|
-
UnexpectedComma = "unexpected ','",
|
|
5828
|
-
TypeArgumentCountMismatch = "type argument count doesn't match expected amount",
|
|
5829
|
-
MissingTypeArgumentClose = "no matching '>' for '<'",
|
|
5830
|
-
UnexpectedPrimitiveTypeArguments = "primitive types not expected to have type arguments",
|
|
5831
|
-
UnexpectedVectorTypeArgumentCount = "vector type expected to have exactly one type argument",
|
|
5832
|
-
UnexpectedStructFormat = "unexpected struct format, must be of the form 0xaddress::module_name::struct_name",
|
|
5833
|
-
InvalidModuleNameCharacter = "module name must only contain alphanumeric or '_' characters",
|
|
5834
|
-
InvalidStructNameCharacter = "struct name must only contain alphanumeric or '_' characters"
|
|
5835
|
-
}
|
|
5836
|
-
declare class TypeTagParserError extends Error {
|
|
5837
|
-
constructor(typeTagStr: string, invalidReason: TypeTagParserErrorType);
|
|
5838
|
-
}
|
|
5839
|
-
/**
|
|
5840
|
-
* All types are made of a few parts they're either:
|
|
5841
|
-
* 1. A simple type e.g. u8
|
|
5842
|
-
* 2. A standalone struct e.g. 0x1::account::Account
|
|
5843
|
-
* 3. A nested struct e.g. 0x1::coin::Coin<0x1234::coin::MyCoin>
|
|
5844
|
-
*
|
|
5845
|
-
* There are a few more special cases that need to be handled, however.
|
|
5846
|
-
* 1. Multiple generics e.g 0x1::pair::Pair<u8, u16>
|
|
5847
|
-
* 2. Spacing in the generics e.g. 0x1::pair::Pair< u8 , u16>
|
|
5848
|
-
* 3. Nested generics of different depths e.g. 0x1::pair::Pair<0x1::coin::Coin<0x1234::coin::MyCoin>, u8>
|
|
5849
|
-
* 4. Generics for types in ABIs are filled in with placeholders e.g T1, T2, T3
|
|
5850
|
-
*/
|
|
5851
|
-
declare function parseTypeTag(typeStr: string, options?: {
|
|
5852
|
-
allowGenerics?: boolean;
|
|
5853
|
-
}): TypeTag;
|
|
5854
|
-
|
|
5855
6003
|
/**
|
|
5856
6004
|
* A class to handle all `Build` transaction operations
|
|
5857
6005
|
*/
|
|
@@ -6054,7 +6202,7 @@ type GetAptosRequestOptions = Omit<GetRequestOptions, "type">;
|
|
|
6054
6202
|
*/
|
|
6055
6203
|
declare function get<Req extends {}, Res extends {}>(options: GetRequestOptions): Promise<AptosResponse<Req, Res>>;
|
|
6056
6204
|
declare function getAptosFullNode<Req extends {}, Res extends {}>(options: GetAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
|
|
6057
|
-
declare function paginateWithCursor<Req extends Record<string, any>, Res extends
|
|
6205
|
+
declare function paginateWithCursor<Req extends Record<string, any>, Res extends Array<{}>>(options: GetAptosRequestOptions): Promise<Res>;
|
|
6058
6206
|
|
|
6059
6207
|
type PostRequestOptions = {
|
|
6060
6208
|
/**
|
|
@@ -6106,4 +6254,228 @@ declare function postAptosFullNode<Req extends {}, Res extends {}>(options: Post
|
|
|
6106
6254
|
declare function postAptosIndexer<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
|
|
6107
6255
|
declare function postAptosFaucet<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
|
|
6108
6256
|
|
|
6109
|
-
|
|
6257
|
+
/**
|
|
6258
|
+
* A wrapper that handles and manages an account sequence number.
|
|
6259
|
+
*
|
|
6260
|
+
* Submit up to `maximumInFlight` transactions per account in parallel with a timeout of `sleepTime`
|
|
6261
|
+
* If local assumes `maximumInFlight` are in flight, determine the actual committed state from the network
|
|
6262
|
+
* If there are less than `maximumInFlight` due to some being committed, adjust the window
|
|
6263
|
+
* If `maximumInFlight` are in flight, wait `sleepTime` seconds before re-evaluating
|
|
6264
|
+
* If ever waiting more than `maxWaitTime` restart the sequence number to the current on-chain state
|
|
6265
|
+
*
|
|
6266
|
+
* Assumptions:
|
|
6267
|
+
* Accounts are expected to be managed by a single AccountSequenceNumber and not used otherwise.
|
|
6268
|
+
* They are initialized to the current on-chain state, so if there are already transactions in
|
|
6269
|
+
* flight, they may take some time to reset.
|
|
6270
|
+
* Accounts are automatically initialized if not explicitly
|
|
6271
|
+
*
|
|
6272
|
+
* Notes:
|
|
6273
|
+
* This is co-routine safe, that is many async tasks can be reading from this concurrently.
|
|
6274
|
+
* The state of an account cannot be used across multiple AccountSequenceNumber services.
|
|
6275
|
+
* The synchronize method will create a barrier that prevents additional nextSequenceNumber
|
|
6276
|
+
* calls until it is complete.
|
|
6277
|
+
* This only manages the distribution of sequence numbers it does not help handle transaction
|
|
6278
|
+
* failures.
|
|
6279
|
+
* If a transaction fails, you should call synchronize and wait for timeouts.
|
|
6280
|
+
*/
|
|
6281
|
+
|
|
6282
|
+
declare class AccountSequenceNumber {
|
|
6283
|
+
readonly aptosConfig: AptosConfig;
|
|
6284
|
+
readonly account: Account$1;
|
|
6285
|
+
lastUncommintedNumber: bigint | null;
|
|
6286
|
+
currentNumber: bigint | null;
|
|
6287
|
+
/**
|
|
6288
|
+
* We want to guarantee that we preserve ordering of workers to requests.
|
|
6289
|
+
*
|
|
6290
|
+
* `lock` is used to try to prevent multiple coroutines from accessing a shared resource at the same time,
|
|
6291
|
+
* which can result in race conditions and data inconsistency.
|
|
6292
|
+
* This code actually doesn't do it though, since we aren't giving out a slot, it is still somewhat a race condition.
|
|
6293
|
+
*
|
|
6294
|
+
* The ideal solution is likely that each thread grabs the next number from a incremental integer.
|
|
6295
|
+
* When they complete, they increment that number and that entity is able to enter the `lock`.
|
|
6296
|
+
* That would guarantee ordering.
|
|
6297
|
+
*/
|
|
6298
|
+
lock: boolean;
|
|
6299
|
+
maxWaitTime: number;
|
|
6300
|
+
maximumInFlight: number;
|
|
6301
|
+
sleepTime: number;
|
|
6302
|
+
constructor(aptosConfig: AptosConfig, account: Account$1, maxWaitTime: number, maximumInFlight: number, sleepTime: number);
|
|
6303
|
+
/**
|
|
6304
|
+
* Returns the next available sequence number for this account
|
|
6305
|
+
*
|
|
6306
|
+
* @returns next available sequence number
|
|
6307
|
+
*/
|
|
6308
|
+
nextSequenceNumber(): Promise<bigint | null>;
|
|
6309
|
+
/**
|
|
6310
|
+
* Initializes this account with the sequence number on chain
|
|
6311
|
+
*/
|
|
6312
|
+
initialize(): Promise<void>;
|
|
6313
|
+
/**
|
|
6314
|
+
* Updates this account sequence number with the one on-chain
|
|
6315
|
+
*
|
|
6316
|
+
* @returns on-chain sequence number for this account
|
|
6317
|
+
*/
|
|
6318
|
+
update(): Promise<bigint>;
|
|
6319
|
+
/**
|
|
6320
|
+
* Synchronizes local sequence number with the seqeunce number on chain for this account.
|
|
6321
|
+
*
|
|
6322
|
+
* Poll the network until all submitted transactions have either been committed or until
|
|
6323
|
+
* the maximum wait time has elapsed
|
|
6324
|
+
*/
|
|
6325
|
+
synchronize(): Promise<void>;
|
|
6326
|
+
}
|
|
6327
|
+
|
|
6328
|
+
/**
|
|
6329
|
+
* The AsyncQueue class is an async-aware data structure that provides a queue-like
|
|
6330
|
+
* behavior for managing asynchronous tasks or operations.
|
|
6331
|
+
* It allows to enqueue items and dequeue them asynchronously.
|
|
6332
|
+
* This is not thread-safe but it is async concurrency safe and
|
|
6333
|
+
* it does not guarantee ordering for those that call into and await on enqueue.
|
|
6334
|
+
*/
|
|
6335
|
+
declare class AsyncQueue<T> {
|
|
6336
|
+
readonly queue: T[];
|
|
6337
|
+
private pendingDequeue;
|
|
6338
|
+
private cancelled;
|
|
6339
|
+
/**
|
|
6340
|
+
* The enqueue method adds an item to the queue. If there are pending dequeued promises,
|
|
6341
|
+
* in the pendingDequeue, it resolves the oldest promise with the enqueued item immediately.
|
|
6342
|
+
* Otherwise, it adds the item to the queue.
|
|
6343
|
+
*
|
|
6344
|
+
* @param item T
|
|
6345
|
+
*/
|
|
6346
|
+
enqueue(item: T): void;
|
|
6347
|
+
/**
|
|
6348
|
+
* The dequeue method returns a promise that resolves to the next item in the queue.
|
|
6349
|
+
* If the queue is not empty, it resolves the promise immediately with the next item.
|
|
6350
|
+
* Otherwise, it creates a new promise. The promise's resolve function is stored
|
|
6351
|
+
* in the pendingDequeue with a unique counter value as the key.
|
|
6352
|
+
* The newly created promise is then returned, and it will be resolved later when an item is enqueued.
|
|
6353
|
+
*
|
|
6354
|
+
* @returns Promise<T>
|
|
6355
|
+
*/
|
|
6356
|
+
dequeue(): Promise<T>;
|
|
6357
|
+
/**
|
|
6358
|
+
* The isEmpty method returns whether the queue is empty or not.
|
|
6359
|
+
*
|
|
6360
|
+
* @returns boolean
|
|
6361
|
+
*/
|
|
6362
|
+
isEmpty(): boolean;
|
|
6363
|
+
/**
|
|
6364
|
+
* The cancel method cancels all pending promises in the queue.
|
|
6365
|
+
* It rejects the promises with a AsyncQueueCancelledError error,
|
|
6366
|
+
* ensuring that any awaiting code can handle the cancellation appropriately.
|
|
6367
|
+
*/
|
|
6368
|
+
cancel(): void;
|
|
6369
|
+
/**
|
|
6370
|
+
* The isCancelled method returns whether the queue is cancelled or not.
|
|
6371
|
+
*
|
|
6372
|
+
* @returns boolean
|
|
6373
|
+
*/
|
|
6374
|
+
isCancelled(): boolean;
|
|
6375
|
+
/**
|
|
6376
|
+
* The pendingDequeueLength method returns the length of the pendingDequeue.
|
|
6377
|
+
*
|
|
6378
|
+
* @returns number
|
|
6379
|
+
*/
|
|
6380
|
+
pendingDequeueLength(): number;
|
|
6381
|
+
}
|
|
6382
|
+
|
|
6383
|
+
/**
|
|
6384
|
+
* TransactionWorker provides a simple framework for receiving payloads to be processed.
|
|
6385
|
+
*
|
|
6386
|
+
* Once one `start()` the process and pushes a new transaction, the worker acquires
|
|
6387
|
+
* the current account's next sequence number (by using the AccountSequenceNumber class),
|
|
6388
|
+
* generates a signed transaction and pushes an async submission process into the `outstandingTransactions` queue.
|
|
6389
|
+
* At the same time, the worker processes transactions by reading the `outstandingTransactions` queue
|
|
6390
|
+
* and submits the next transaction to chain, it
|
|
6391
|
+
* 1) waits for resolution of the submission process or get pre-execution validation error
|
|
6392
|
+
* and 2) waits for the resolution of the execution process or get an execution error.
|
|
6393
|
+
* The worker fires events for any submission and/or execution success and/or failure.
|
|
6394
|
+
*/
|
|
6395
|
+
|
|
6396
|
+
declare class TransactionWorker {
|
|
6397
|
+
readonly aptosConfig: AptosConfig;
|
|
6398
|
+
readonly account: Account$1;
|
|
6399
|
+
readonly accountSequnceNumber: AccountSequenceNumber;
|
|
6400
|
+
readonly taskQueue: AsyncQueue<() => Promise<void>>;
|
|
6401
|
+
started: boolean;
|
|
6402
|
+
/**
|
|
6403
|
+
* transactions payloads waiting to be generated and signed
|
|
6404
|
+
*
|
|
6405
|
+
* TODO support entry function payload from ABI builder
|
|
6406
|
+
*/
|
|
6407
|
+
transactionsQueue: AsyncQueue<[InputGenerateTransactionPayloadData, InputGenerateTransactionOptions | undefined]>;
|
|
6408
|
+
/**
|
|
6409
|
+
* signed transactions waiting to be submitted
|
|
6410
|
+
*/
|
|
6411
|
+
outstandingTransactions: AsyncQueue<[Promise<PendingTransactionResponse>, bigint]>;
|
|
6412
|
+
/**
|
|
6413
|
+
* transactions that have been submitted to chain
|
|
6414
|
+
*/
|
|
6415
|
+
sentTransactions: Array<[string, bigint, any]>;
|
|
6416
|
+
/**
|
|
6417
|
+
* transactions that have been committed to chain
|
|
6418
|
+
*/
|
|
6419
|
+
executedTransactions: Array<[string, bigint, any]>;
|
|
6420
|
+
/**
|
|
6421
|
+
* Provides a simple framework for receiving payloads to be processed.
|
|
6422
|
+
*
|
|
6423
|
+
* @param aptosConfig - a config object
|
|
6424
|
+
* @param sender - a sender as Account
|
|
6425
|
+
* @param maxWaitTime - the max wait time to wait before resyncing the sequence number
|
|
6426
|
+
* to the current on-chain state, default to 30
|
|
6427
|
+
* @param maximumInFlight - submit up to `maximumInFlight` transactions per account.
|
|
6428
|
+
* Mempool limits the number of transactions per account to 100, hence why we default to 100.
|
|
6429
|
+
* @param sleepTime - If `maximumInFlight` are in flight, wait `sleepTime` seconds before re-evaluating, default to 10
|
|
6430
|
+
*/
|
|
6431
|
+
constructor(aptosConfig: AptosConfig, account: Account$1, maxWaitTime?: number, maximumInFlight?: number, sleepTime?: number);
|
|
6432
|
+
/**
|
|
6433
|
+
* Gets the current account sequence number,
|
|
6434
|
+
* generates the transaction with the account sequence number,
|
|
6435
|
+
* adds the transaction to the outstanding transaction queue
|
|
6436
|
+
* to be processed later.
|
|
6437
|
+
*/
|
|
6438
|
+
submitNextTransaction(): Promise<void>;
|
|
6439
|
+
/**
|
|
6440
|
+
* Reads the outstanding transaction queue and submits the transaction to chain.
|
|
6441
|
+
*
|
|
6442
|
+
* If the transaction has fulfilled, it pushes the transaction to the processed
|
|
6443
|
+
* transactions queue and fires a transactionsFulfilled event.
|
|
6444
|
+
*
|
|
6445
|
+
* If the transaction has failed, it pushes the transaction to the processed
|
|
6446
|
+
* transactions queue with the failure reason and fires a transactionsFailed event.
|
|
6447
|
+
*/
|
|
6448
|
+
processTransactions(): Promise<void>;
|
|
6449
|
+
/**
|
|
6450
|
+
* Once transaction has been sent to chain, we check for its execution status.
|
|
6451
|
+
* @param sentTransaction transactions that were sent to chain and are now waiting to be executed
|
|
6452
|
+
* @param sequenceNumber the account's sequence number that was sent with the transaction
|
|
6453
|
+
*/
|
|
6454
|
+
checkTransaction(sentTransaction: PromiseFulfilledResult<PendingTransactionResponse>, sequenceNumber: bigint): Promise<void>;
|
|
6455
|
+
/**
|
|
6456
|
+
* Push transaction to the transactions queue
|
|
6457
|
+
* @param payload Transaction payload
|
|
6458
|
+
*/
|
|
6459
|
+
push(transactionData: InputGenerateTransactionPayloadData, options?: InputGenerateTransactionOptions): Promise<void>;
|
|
6460
|
+
/**
|
|
6461
|
+
* Generates a signed transaction that can be submitted to chain
|
|
6462
|
+
* @param account an Aptos account
|
|
6463
|
+
* @param sequenceNumber a sequence number the transaction will be generated with
|
|
6464
|
+
* @returns
|
|
6465
|
+
*/
|
|
6466
|
+
generateNextTransaction(account: Account$1, sequenceNumber: bigint): Promise<SingleSignerTransaction | undefined>;
|
|
6467
|
+
/**
|
|
6468
|
+
* Starts transaction submission and transaction processing.
|
|
6469
|
+
*/
|
|
6470
|
+
run(): Promise<void>;
|
|
6471
|
+
/**
|
|
6472
|
+
* Starts the transaction management process.
|
|
6473
|
+
*/
|
|
6474
|
+
start(): void;
|
|
6475
|
+
/**
|
|
6476
|
+
* Stops the the transaction management process.
|
|
6477
|
+
*/
|
|
6478
|
+
stop(): void;
|
|
6479
|
+
}
|
|
6480
|
+
|
|
6481
|
+
export { APTOS_BIP44_REGEX, APTOS_COIN, APTOS_HARDENED_REGEX, Account$1 as Account, AccountAddress, AccountAddressInput, AccountAuthenticator, AccountAuthenticatorEd25519, AccountAuthenticatorMultiEd25519, AccountAuthenticatorMultiKey, AccountAuthenticatorSingleKey, AccountAuthenticatorVariant, AccountData, AccountSequenceNumber, AccountSignature, AddressInvalidReason, AnyNumber, AnyPublicKey, AnyPublicKeyVariant, AnyRawTransaction, AnyRawTransactionInstance, AnySignature, AnySignatureVariant, AnyTransactionPayloadInstance, Aptos, AptosApiError, AptosApiType, AptosConfig, AptosRequest, AptosResponse, AptosSettings, AuthenticationKey, AuthenticationKeyScheme, Block, BlockMetadataTransactionResponse, Bool, CKDPriv, ChainId, Client, ClientConfig, ClientRequest, ClientResponse, CommittedTransactionResponse, DEFAULT_MAX_GAS_AMOUNT, DEFAULT_NETWORK, DEFAULT_TXN_EXP_SEC_FROM_NOW, DEFAULT_TXN_TIMEOUT_SEC, DecodedTableData, DeletedTableData, DeriveScheme, DerivedKeys, Deserializable, Deserializer, DirectWriteSet, Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature, EntryFunction, EntryFunctionABI, EntryFunctionArgument, EntryFunctionArgumentTypes, EntryFunctionBytes, EntryFunctionPayloadResponse, Event$1 as Event, EventGuid, FeePayerRawTransaction, FixedBytes, GasEstimation, GenerateAccount, GenerateAccountWithEd25519, GenerateAccountWithSingleSignerSecp256k1Key, GenesisPayload, GenesisTransactionResponse, GetANSNameResponse, GetAccountCoinsDataResponse, GetAccountCollectionsWithOwnedTokenResponse, GetAccountOwnedObjectsResponse, GetAccountOwnedTokensFromCollectionResponse, GetAccountOwnedTokensQueryResponse, GetAptosRequestOptions, GetChainTopUserTransactionsResponse, GetCollectionDataResponse, GetCurrentFungibleAssetBalancesResponse, GetCurrentTokenOwnershipResponse, GetDelegatedStakingActivitiesResponse, GetEventsResponse, GetFungibleAssetActivitiesResponse, GetFungibleAssetMetadataResponse, GetNumberOfDelegatorsResponse, GetOwnedTokensResponse, GetProcessorStatusResponse, GetRequestOptions, GetTokenActivityResponse, GetTokenDataResponse, GraphqlQuery, HARDENED_OFFSET, Hex, HexInput, HexInvalidReason, Identifier, InputEntryFunctionData, InputEntryFunctionDataWithRemoteABI, InputGenerateMultiAgentRawTransactionArgs, InputGenerateMultiAgentRawTransactionData, InputGenerateRawTransactionArgs, InputGenerateSingleSignerRawTransactionArgs, InputGenerateSingleSignerRawTransactionData, InputGenerateTransactionData, InputGenerateTransactionOptions, InputGenerateTransactionPayloadData, InputGenerateTransactionPayloadDataWithRemoteABI, InputMultiSigData, InputMultiSigDataWithRemoteABI, InputScriptData, InputSimulateTransactionData, InputSimulateTransactionOptions, InputSubmitTransactionData, InputViewRequestData, KeyType, LedgerInfo, LedgerVersionArg, MimeType, ModuleId, MoveAbility, MoveAddressType, MoveFunction, MoveFunctionGenericTypeParam, MoveFunctionId, MoveFunctionVisibility, MoveModule, MoveModuleBytecode, MoveModuleId, MoveObjectType, MoveOption, MoveOptionType, MoveResource, MoveScriptBytecode, MoveString, MoveStruct, MoveStructField, MoveStructId, MoveStructType, MoveType, MoveUint128Type, MoveUint16Type, MoveUint256Type, MoveUint32Type, MoveUint64Type, MoveUint8Type, MoveValue, MoveVector, MultiAgentRawTransaction, MultiAgentTransaction, MultiEd25519PublicKey, MultiEd25519Signature, MultiKey, MultiSig, MultisigPayloadResponse, MultisigTransactionPayload, Network, NetworkToChainId, NetworkToFaucetAPI, NetworkToIndexerAPI, NetworkToNetworkName, NetworkToNodeAPI, OrderBy, OrderByArg, OrderByValue, PaginationArgs, ParsingError, ParsingResult, PendingTransactionResponse, PostAptosRequestOptions, PostRequestOptions, PrivateKey, ProcessorType, PublicKey, RAW_TRANSACTION_SALT, RAW_TRANSACTION_WITH_DATA_SALT, RawTransaction, RawTransactionWithData, RoleType, RotationProofChallenge, Script, ScriptFunctionArgument, ScriptFunctionArgumentTypes, ScriptPayloadResponse, ScriptTransactionArgumentVariants, ScriptWriteSet, Secp256k1PrivateKey, Secp256k1PublicKey, Secp256k1Signature, Serializable, Serializer, Signature, SignedTransaction, SigningScheme, SigningSchemeInput, SimpleEntryFunctionArgumentTypes, SingleSignerTransaction, StateCheckpointTransactionResponse, StructTag, TableItemRequest, TokenStandard, TokenStandardArg, TransactionArgument, TransactionAuthenticator, TransactionAuthenticatorEd25519, TransactionAuthenticatorFeePayer, TransactionAuthenticatorMultiAgent, TransactionAuthenticatorMultiEd25519, TransactionAuthenticatorSingleSender, TransactionAuthenticatorVariant, TransactionEd25519Signature, TransactionFeePayerSignature, TransactionMultiAgentSignature, TransactionMultiEd25519Signature, TransactionPayload, TransactionPayloadEntryFunction, TransactionPayloadMultisig, TransactionPayloadResponse, TransactionPayloadScript, TransactionPayloadVariants, TransactionResponse, TransactionResponseType, TransactionSecp256k1Signature, TransactionSignature, TransactionVariants, TransactionWorker, TypeTag, TypeTagAddress, TypeTagBool, TypeTagGeneric, TypeTagParserError, TypeTagParserErrorType, TypeTagReference, TypeTagSigner, TypeTagStruct, TypeTagU128, TypeTagU16, TypeTagU256, TypeTagU32, TypeTagU64, TypeTagU8, TypeTagVariants, TypeTagVector, U128, U16, U256, U32, U64, U8, Uint128, Uint16, Uint256, Uint32, Uint64, Uint8, UserTransactionResponse, ViewRequest, WaitForTransactionOptions, WhereArg, WriteSet, WriteSetChange, WriteSetChangeDeleteModule, WriteSetChangeDeleteResource, WriteSetChangeDeleteTableItem, WriteSetChangeWriteModule, WriteSetChangeWriteResource, WriteSetChangeWriteTableItem, aptosCoinStructTag, aptosRequest, buildTransaction, checkOrConvertArgument, convertArgument, deriveKey, deriveTransactionType, deserializeFromScriptArgument, ensureBoolean, fetchEntryFunctionAbi, findFirstNonSignerArg, generateMultiSignersSignedTransaction, generateRawTransaction, generateSignedTransaction, generateSignedTransactionForSimulation, generateSigningMessage, generateTransactionPayload, generateTransactionPayloadWithABI, get, getAptosFullNode, getAuthenticatorForSimulation, getFunctionParts, isBcsAddress, isBcsBool, isBcsFixedBytes, isBcsString, isBcsU128, isBcsU16, isBcsU256, isBcsU32, isBcsU64, isBcsU8, isBlockMetadataTransactionResponse, isBool, isEd25519Signature, isEncodedEntryFunctionArgument, isFeePayerSignature, isGenesisTransactionResponse, isLargeNumber, isMultiAgentSignature, isMultiEd25519Signature, isNull, isNumber, isPendingTransactionResponse, isScriptDataInput, isSecp256k1Signature, isStateCheckpointTransactionResponse, isString, isUserTransactionResponse, isValidBIP44Path, isValidHardenedPath, mnemonicToSeed, objectStructTag, optionStructTag, outOfRangeErrorMessage, paginateWithCursor, parseTypeTag, post, postAptosFaucet, postAptosFullNode, postAptosIndexer, request, sign, splitPath, standardizeTypeTags, stringStructTag, throwTypeMismatch, validateNumberInRange };
|