Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: validate cw20 queries #3706

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions typescript-sdk/bun.lock
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"lockfileVersion": 1,
"lockfileVersion": 0,
"workspaces": {
"": {
"name": "@unionlabs/client",
Expand All @@ -16,6 +16,7 @@
"ofetch": "^1.4.1",
"ox": "^0.6.9",
"patch-package": "^8.0.0",
"valibot": "^1.0.0-beta.15",
"viem": "^2.22.21",
},
"devDependencies": {
Expand Down Expand Up @@ -47,7 +48,11 @@

"@aptos-labs/aptos-client": ["@aptos-labs/aptos-client@0.1.1", "", { "dependencies": { "axios": "1.7.4", "got": "^11.8.6" } }, "sha512-kJsoy4fAPTOhzVr7Vwq8s/AUg6BQiJDa7WOqRzev4zsuIS3+JCuIZ6vUd7UBsjnxtmguJJulMRs9qWCzVBt2XA=="],

"@aptos-labs/ts-sdk": ["@aptos-labs/ts-sdk@1.33.2", "", { "dependencies": { "@aptos-labs/aptos-cli": "^1.0.2", "@aptos-labs/aptos-client": "^0.1.1", "@noble/curves": "^1.4.0", "@noble/hashes": "^1.4.0", "@scure/bip32": "^1.4.0", "@scure/bip39": "^1.3.0", "eventemitter3": "^5.0.1", "form-data": "^4.0.0", "js-base64": "^3.7.7", "jwt-decode": "^4.0.0", "poseidon-lite": "^0.2.0" } }, "sha512-nbro7x9HudBDLngOW8IpRCAysb6si1kE0F4pUfDesRHzRcqivnQzv8O5ePZma7jkTgpjGNx6gdEBXKI6YcJbww=="],
"@aptos-labs/aptos-dynamic-transaction-composer": ["@aptos-labs/aptos-dynamic-transaction-composer@0.1.3", "", {}, "sha512-bJl+Zq5QbhpcPIJakAkl9tnT3T02mxCYhZThQDhUmjsOZ5wMRlKJ0P7aaq1dmlybSHkVj7vRgOy2t86/NDKKng=="],

"@aptos-labs/script-composer-pack": ["@aptos-labs/script-composer-pack@0.0.9", "", { "dependencies": { "@aptos-labs/aptos-dynamic-transaction-composer": "^0.1.3" } }, "sha512-Y3kA1rgF65HETgoTn2omDymsgO+fnZouPLrKJZ9sbxTGdOekIIHtGee3A2gk84eCqa02ZKBumZmP+IDCXRtU/g=="],

"@aptos-labs/ts-sdk": ["@aptos-labs/ts-sdk@1.34.0", "", { "dependencies": { "@aptos-labs/aptos-cli": "^1.0.2", "@aptos-labs/aptos-client": "^0.1.1", "@aptos-labs/script-composer-pack": "^0.0.9", "@noble/curves": "^1.4.0", "@noble/hashes": "^1.4.0", "@scure/bip32": "^1.4.0", "@scure/bip39": "^1.3.0", "eventemitter3": "^5.0.1", "form-data": "^4.0.0", "js-base64": "^3.7.7", "jwt-decode": "^4.0.0", "poseidon-lite": "^0.2.0" } }, "sha512-+mKsx41L+g7F5HhB5Z8/pouiHYN/ajpCrbKZxQsDLqi5gf37IpZ44F6qZMklQO0LCTBQwhBkq4y67p9AGXjO4g=="],

"@cosmjs/amino": ["@cosmjs/amino@0.33.0", "", { "dependencies": { "@cosmjs/crypto": "^0.33.0", "@cosmjs/encoding": "^0.33.0", "@cosmjs/math": "^0.33.0", "@cosmjs/utils": "^0.33.0" } }, "sha512-a4qnWGzuM2IrlkDTFQmU7bDd+wNIzyvfcRIZ43i00ZHvTEtrCcWopT94rIv/Zy6fdgkhQ3HWrsGVlIPDT/ibRw=="],

Expand Down Expand Up @@ -717,6 +722,8 @@

"universalify": ["universalify@2.0.1", "", {}, "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw=="],

"valibot": ["valibot@1.0.0-beta.15", "", { "peerDependencies": { "typescript": ">=5" }, "optionalPeers": ["typescript"] }, "sha512-BKy8XosZkDHWmYC+cJG74LBzP++Gfntwi33pP3D3RKztz2XV9jmFWnkOi21GoqARP8wAWARwhV6eTr1JcWzjGw=="],

"viem": ["viem@2.22.22", "", { "dependencies": { "@noble/curves": "1.8.1", "@noble/hashes": "1.7.1", "@scure/bip32": "1.6.2", "@scure/bip39": "1.5.4", "abitype": "1.0.8", "isows": "1.0.6", "ox": "0.6.7", "ws": "8.18.0" }, "peerDependencies": { "typescript": ">=5.0.4" }, "optionalPeers": ["typescript"] }, "sha512-0z7EFheP+paC/KRlVpu7zXYiqkTX6GR86G0p84LnYr5NgaVxGz0mGsiERy41ThERX1ahkTdEWGGiNgfi6wVqBQ=="],

"vite": ["vite@6.1.0", "", { "dependencies": { "esbuild": "^0.24.2", "postcss": "^8.5.1", "rollup": "^4.30.1" }, "optionalDependencies": { "fsevents": "~2.3.3" }, "peerDependencies": { "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", "jiti": ">=1.21.0", "less": "*", "lightningcss": "^1.21.0", "sass": "*", "sass-embedded": "*", "stylus": "*", "sugarss": "*", "terser": "^5.16.0", "tsx": "^4.8.1", "yaml": "^2.4.2" }, "optionalPeers": ["@types/node", "jiti", "less", "lightningcss", "sass", "sass-embedded", "stylus", "sugarss", "terser", "tsx", "yaml"], "bin": { "vite": "bin/vite.js" } }, "sha512-RjjMipCKVoR4hVfPY6GQTgveinjNuyLw+qruksLDvA5ktI1150VmcMBKmQaEWJhg/j6Uaf6dNCNA0AfdzUb/hQ=="],
Expand Down
1 change: 1 addition & 0 deletions typescript-sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"ofetch": "^1.4.1",
"ox": "^0.6.9",
"patch-package": "^8.0.0",
"valibot": "^1.0.0-beta.15",
"viem": "^2.22.21"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion typescript-sdk/src/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export {
getCosmosHeight,
queryContractState,
queryCosmosCW20AddressBalance,
queryCosmosC20TokenMetadata,
queryCosmosCW20TokenMetadata,
getCosmosTransactionReceipt,
getAptosAccountTransactions,
getCosmosAccountTransactions
Expand Down
40 changes: 35 additions & 5 deletions typescript-sdk/src/query/on-chain.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import { ofetch } from "ofetch"
import type { Prettify } from "../types.ts"
import * as v from "valibot"
import { Base64, Hex, Json } from "ox"
import { ResultAsync, err, ok, type Result } from "neverthrow"
import type { Prettify } from "../types.ts"
import { CosmWasmClient } from "@cosmjs/cosmwasm-stargate"
import { ResultAsync, err, ok, type Result } from "neverthrow"
import { cosmosRpcs, type CosmosChainId } from "#cosmos/client.ts"

type rpcUrlArgument = { rpcUrl: string }
Expand Down Expand Up @@ -39,6 +40,12 @@ type CosmosTransactionReceipt = {
}
}

const CW20BalanceSchema = v.object({
balance: v.string()
})

type CW20Balance = v.InferOutput<typeof CW20BalanceSchema>

/**
* get the balance of a given address for a given cw20 contract
* @example
Expand Down Expand Up @@ -72,9 +79,26 @@ export async function queryCosmosCW20AddressBalance({
}
)

return balance.andThen(balance => ok(balance.balance))
return balance.andThen(balance => {
const parsed = v.safeParse(CW20BalanceSchema, balance)
if (!parsed.success) {
return err(
new Error(`failed to parse balance for contract ${contractAddress}`, { cause: parsed })
)
}
return ok(parsed.output.balance)
})
}

const CW20TokenMetadataSchema = v.object({
name: v.string(),
symbol: v.string(),
decimals: v.number(),
total_supply: v.string()
})

type CW20TokenMetadata = v.InferOutput<typeof CW20TokenMetadataSchema>

/**
* get the metadata of a given cw20 contract
* @example
Expand All @@ -85,7 +109,7 @@ export async function queryCosmosCW20AddressBalance({
* })
* ```
*/
export async function queryCosmosC20TokenMetadata({
export async function queryCosmosCW20TokenMetadata({
contractAddress,
chainId
}: {
Expand Down Expand Up @@ -118,7 +142,13 @@ export async function queryCosmosC20TokenMetadata({
})
}
)
return response
return response.andThen(response => {
const parsed = v.safeParse(CW20TokenMetadataSchema, response)
if (!parsed.success) {
return err(new Error(`failed to parse token info for contract ${contractAddress}`, { cause: parsed }))
}
return ok(parsed.output)
})
}

const CW20_PREFIXES = [
Expand Down